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

Class to hold Tag history. More...

#include <tag.hpp>

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

Public Member Functions

 History (const string &json)
 Constructs an Tag::History object from a JSON string. More...
 
 History ()
 Constructs an empty Tag::History object. More...
 
virtual bool valid () const
 Returns true if the Entity holds valid data. More...
 
uint_fast64_t accounts ()
 Returns the number of accounts using that hashtag. More...
 
const system_clock::time_point day ()
 Returns the day. More...
 
uint_fast64_t uses ()
 Returns the number of accounts using that hashtag. 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 Tag history.

Since
0.16.0

Constructor & Destructor Documentation

◆ History() [1/2]

Tag::History::History ( const string &  json)
explicit

Constructs an Tag::History object from a JSON string.

Parameters
jsonJSON string
Since
0.16.0
73 : Entity(json)
74 {}
Entity()
Constructs an empty Entity object.
Definition: entity.cpp:65

◆ History() [2/2]

Constructs an empty Tag::History object.

Since
0.16.0
77 : Entity()
78 {}
Entity()
Constructs an empty Entity object.
Definition: entity.cpp:65

Member Function Documentation

◆ accounts()

uint_fast64_t Tag::History::accounts ( )

Returns the number of accounts using that hashtag.

Since
0.16.0
93 {
94  return stouint64(get_string("accounts"));
95 }
const string get_string(const string &key) const
Returns the value of key as std::string.
Definition: entity.cpp:134

◆ day()

const system_clock::time_point Tag::History::day ( )

Returns the day.

Since
0.16.0
98 {
99  const Json::Value node = get("day");
100 
101  if (node.isString())
102  {
103  std::chrono::seconds seconds(stouint64(node.asString()));
104  return system_clock::time_point(seconds);
105  }
106 
107  ttdebug << "Could not get data: day\n";
108  return system_clock::time_point();
109 }

◆ uses()

uint_fast64_t Tag::History::uses ( )

Returns the number of accounts using that hashtag.

Since
0.16.0
112 {
113  return stouint64(get_string("uses"));
114 }
const string get_string(const string &key) const
Returns the value of key as std::string.
Definition: entity.cpp:134

◆ valid()

bool Tag::History::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.

81 {
82  const std::vector<string> attributes =
83  {{
84  "day",
85  "uses",
86  "accounts"
87  }};
88 
89  return Entity::check_valid(attributes);
90 }
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: