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

Class to hold contexts. More...

#include <context.hpp>

Inheritance diagram for Mastodon::Easy::Context:
Mastodon::Easy::Entity

Public Member Functions

 Context (const string &json)
 Constructs a Context object from a JSON string. More...
 
 Context ()
 Constructs an empty Context object. More...
 
virtual bool valid () const
 Returns true if the Entity holds valid data. More...
 
const std::vector< Statusancestors () const
 Returns the ancestors of the Status as vector of Statuses. More...
 
const std::vector< Statusdescendants () const
 Returns the descendants of the Status as vector of Statuses. 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 contexts.

Since
before 0.11.0

Constructor & Destructor Documentation

◆ Context() [1/2]

Context::Context ( const string &  json)
explicit

Constructs a Context 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

◆ Context() [2/2]

Context::Context ( )

Constructs an empty Context object.

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

Member Function Documentation

◆ ancestors()

const std::vector< Easy::Status > Context::ancestors ( ) const

Returns the ancestors of the Status as vector of Statuses.

Since
before 0.11.0
43 {
44  const Json::Value node = get("ancestors");
45  if (node.isArray())
46  {
47  std::vector<Easy::Status> vec;
48  for (const Json::Value &value : node)
49  {
50  vec.push_back(Easy::Status(value.toStyledString()));
51  }
52  return vec;
53  }
54 
55  ttdebug << "Could not get data: ancestors\n";
56  return {};
57 }
Class to hold statuses.
Definition: status.hpp:59

◆ descendants()

const std::vector< Easy::Status > Context::descendants ( ) const

Returns the descendants of the Status as vector of Statuses.

Since
before 0.11.0
60 {
61  const Json::Value node = get("descendants");
62  if (node.isArray())
63  {
64  std::vector<Easy::Status> vec;
65  for (const Json::Value &value : node)
66  {
67  vec.push_back(Easy::Status(value.toStyledString()));
68  }
69  return vec;
70  }
71 
72  ttdebug << "Could not get data: descendants\n";
73  return {};
74 }
Class to hold statuses.
Definition: status.hpp:59

◆ valid()

bool Context::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  "ancestors",
36  "descendants"
37  }};
38 
39  return Entity::check_valid(attributes);
40 }
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: