mastodon-cpp  0.104.0
Classes | Public Member Functions | List of all members
Mastodon::Easy::Tag Class Reference

Class to hold tags. More...

#include <tag.hpp>

Inheritance diagram for Mastodon::Easy::Tag:
Mastodon::Easy::Entity

Classes

class  History
 Class to hold Tag history. More...
 

Public Member Functions

virtual bool valid () const override
 Returns true if the Entity holds valid data. More...
 
const string name () const
 Returns the name of the tag. More...
 
const string url () const
 Returns the URL of the tag. More...
 
const std::vector< Historyhistory () const
 Returns the history of the tag. More...
 
 Entity (const string &json)
 Constructs an Entity object from a JSON string. More...
 
 Entity (const Json::Value &object)
 Constructs an Entity object from a JSON object. More...
 
 Entity ()
 Constructs an empty Entity object. More...
 
- Public Member Functions inherited from Mastodon::Easy::Entity
 Entity (const string &json)
 Constructs an Entity object from a JSON string. More...
 
 Entity (const Json::Value &object)
 Constructs an Entity object from a JSON object. More...
 
 Entity ()
 Constructs an empty Entity object. More...
 
virtual ~Entity ()
 Destroys the object. More...
 
 operator const Json::Value () const
 
void from_string (const string &json)
 Replaces the Entity with a new one from a JSON string. More...
 
const string to_string () const
 Returns the JSON of the Entity as string. More...
 
void from_object (const Json::Value &object)
 Replaces the Entity with a new one from a JSON object. 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...
 
uint64_t get_uint64 (const string &key) const
 Returns the value of key as std::uint64_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 Easy::time get_time (const string &key) const
 Returns the value of key as Easy::time. 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::uint64_t stouint64 (const string &str) const
 Returns value of str as uint64_t.
 
bool check_valid (const std::vector< string > &attributes) const
 Checks if an Entity is valid. More...
 

Detailed Description

Class to hold tags.

Since
before 0.11.0

Member Function Documentation

◆ Entity() [1/3]

Easy::Entity::Entity
explicit

Constructs an Entity object from a JSON string.

Parameters
jsonJSON string
Since
before 0.11.0
31 : _tree(Json::nullValue)
32 ,_was_set(false)
33 {
34  from_string(json);
35 }
void from_string(const string &json)
Replaces the Entity with a new one from a JSON string.
Definition: entity.cpp:55

◆ Entity() [2/3]

Easy::Entity::Entity

Constructs an empty Entity object.

Since
before 0.11.0
43 : _tree(Json::nullValue)
44 , _was_set(false)
45 {}

◆ Entity() [3/3]

Easy::Entity::Entity
explicit

Constructs an Entity object from a JSON object.

Parameters
objectJSON object
Since
0.100.0
38 : _tree(object)
39 ,_was_set(false)
40 {}

◆ history()

const std::vector< Tag::History > Tag::history ( ) const

Returns the history of the tag.

Since
0.16.0
48 {
49  const Json::Value node = get("history");
50  if (node.isArray())
51  {
52  std::vector<Easy::Tag::History> vec;
53  std::transform(node.begin(), node.end(), std::back_inserter(vec),
54  [](const Json::Value &value)
55  { return Easy::Tag::History(value); });
56  return vec;
57  }
58 
59  ttdebug << "Could not get data: history\n";
60  return {};
61 }
Class to hold Tag history.
Definition: tag.hpp:52

◆ name()

const string Tag::name ( ) const

Returns the name of the tag.

Since
before 0.11.0
38 {
39  return get_string("name");
40 }
const string get_string(const string &key) const
Returns the value of key as std::string.
Definition: entity.cpp:173

◆ url()

const string Tag::url ( ) const

Returns the URL of the tag.

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

◆ valid()

bool Tag::valid ( ) const
overridevirtual

Returns true if the Entity holds valid data.

Since
before 0.11.0 (virtual since 0.18.2)

Implements Mastodon::Easy::Entity.

27 {
28  const std::vector<string> attributes =
29  {{
30  "name",
31  "url"
32  }};
33 
34  return Entity::check_valid(attributes);
35 }
bool check_valid(const std::vector< string > &attributes) const
Checks if an Entity is valid.
Definition: entity.cpp:101

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