mastodon-cpp  0.16.1
Public Member Functions | List of all members
Mastodon::Easy::Instance Class Reference

Class to hold instances. More...

#include <instance.hpp>

Inheritance diagram for Mastodon::Easy::Instance:
Mastodon::Easy::Entity

Public Member Functions

 Instance (const string &json)
 Constructs an Instance object from a JSON string. More...
 
 Instance ()
 Constructs an empty Instance object.
 
const Account contact_account () const
 Returns the Account of the admin or another contact person.
 
const string description () const
 Returns the description of the instance.
 
const string email () const
 Returns the email address which can be used to contact the instance administrator.
 
const std::vector< string > languages () const
 Returns a vector of ISO 6391 language codes the instance has chosen to advertise.
 
const string title () const
 Returns the title of the instance.
 
const string uri () const
 Returns the URI of the instance.
 
const string version () const
 Returns the version used by the instance.
 
const string streaming_api () const
 Returns the URL for the streaming API.
 
- Public Member Functions inherited from Mastodon::Easy::Entity
 Entity (const string &json)
 Constructs an Entity object from a JSON string. More...
 
 Entity ()
 Constructs an empty Entity object.
 
const void from_string (const string &json)
 Replaces the Entity with a new one from a JSON string. More...
 
const Json::Value to_object () const
 Returns the JSON object of the Entity. More...
 
const bool valid () const
 Returns true if the Entity holds valid data.
 
const string error () const
 Returns error string sent by the server.
 
const bool was_set () const
 Returns true if the last requested value was set, false if it was unset. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Mastodon::Easy::Entity
const Json::Value get (const string &key) const
 Returns the value of key as Json::Value. More...
 
const string get_string (const string &key) const
 Returns the value of key as std::string. More...
 
const uint_fast64_t get_uint64 (const string &key) const
 Returns the value of key as std::uint_fast64_t. More...
 
const double get_double (const string &key) const
 Returns the value of key as double. More...
 
const bool get_bool (const string &key) const
 Returns the value of key as bool. More...
 
const system_clock::time_point get_time_point (const string &key) const
 Returns the value of key as time_point. More...
 
const std::vector< string > get_vector (const string &key) const
 Returns the value of key as vector. More...
 
const std::uint_fast64_t stouint64 (const string &str) const
 

Detailed Description

Class to hold instances.

Constructor & Destructor Documentation

◆ Instance()

Instance::Instance ( const string &  json)
explicit

Constructs an Instance object from a JSON string.

Parameters
jsonJSON string
26 : Entity(json)
27 {}
Entity()
Constructs an empty Entity object.
Definition: entity.cpp:70

The documentation for this class was generated from the following files: