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

Class to hold emojis. More...

#include <emoji.hpp>

Inheritance diagram for Mastodon::Easy::Emoji:
Mastodon::Easy::Entity

Public Member Functions

 Emoji (const string &json)
 Constructs an Emoji object from a JSON string. More...
 
 Emoji ()
 Constructs an empty Emoji object. More...
 
virtual bool valid () const
 Returns true if the Entity holds valid data. More...
 
const string shortcode () const
 Returns the shortcode of the emoji. More...
 
const string static_url () const
 Returns the URL to the emoji static image. More...
 
const string url () const
 Returns the URL to the emoji image. More...
 
- 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. More...
 
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 string error () const
 Returns error string sent by the server. More...
 
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...
 
uint_fast64_t get_uint64 (const string &key) const
 Returns the value of key as std::uint_fast64_t. More...
 
double get_double (const string &key) const
 Returns the value of key as double. More...
 
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...
 
void set (const string &key, const Json::Value &value)
 Sets the value of key. More...
 
std::uint_fast64_t stouint64 (const string &str) const
 
bool check_valid (const std::vector< string > &attributes) const
 Checks if an Entity is valid. More...
 

Detailed Description

Class to hold emojis.

Since
before 0.11.0

Constructor & Destructor Documentation

◆ Emoji() [1/2]

Emoji::Emoji ( const string &  json)
explicit

Constructs an Emoji object from a JSON string.

Parameters
jsonJSON string
Since
before 0.11.0
24 : Entity(json)
25 {}
Entity()
Constructs an empty Entity object.
Definition: entity.cpp:65

◆ Emoji() [2/2]

Emoji::Emoji ( )

Constructs an empty Emoji object.

Since
before 0.11.0
28 : Entity()
29 {}
Entity()
Constructs an empty Entity object.
Definition: entity.cpp:65

Member Function Documentation

◆ shortcode()

const string Emoji::shortcode ( ) const

Returns the shortcode of the emoji.

Since
before 0.11.0
44 {
45  return get_string("shortcode");
46 }
const string get_string(const string &key) const
Returns the value of key as std::string.
Definition: entity.cpp:134

◆ static_url()

const string Emoji::static_url ( ) const

Returns the URL to the emoji static image.

Since
before 0.11.0
49 {
50  return get_string("static_url");
51 }
const string get_string(const string &key) const
Returns the value of key as std::string.
Definition: entity.cpp:134

◆ url()

const string Emoji::url ( ) const

Returns the URL to the emoji image.

Since
before 0.11.0
54 {
55  return get_string("url");
56 }
const string get_string(const string &key) const
Returns the value of key as std::string.
Definition: entity.cpp:134

◆ valid()

bool Emoji::valid ( ) const
virtual

Returns true if the Entity holds valid data.

Since
before 0.11.0 (virtual since 0.18.2)

Implements Mastodon::Easy::Entity.

32 {
33  const std::vector<string> attributes =
34  {{
35  "shortcode",
36  "static_url",
37  "url"
38  }};
39 
40  return Entity::check_valid(attributes);
41 }
bool check_valid(const std::vector< string > &attributes) const
Checks if an Entity is valid.
Definition: entity.cpp:69

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