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

Class to hold results. More...

#include <results.hpp>

Inheritance diagram for Mastodon::Easy::Results:
Mastodon::Easy::Entity

Public Member Functions

virtual bool valid () const override
 Returns true if the Entity holds valid data. More...
 
const std::vector< Accountaccounts () const
 Returns an array of matched Accounts. More...
 
const std::vector< Statusstatuses () const
 Returns an array of matched Statuses. More...
 
const std::vector< string > hashtags_v1 () const
 Returns an array of matched hashtags as string. More...
 
const std::vector< Taghashtags_v2 () const
 Returns an array of matched hashtags as Easy::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 results.

Since
before 0.11.0

Member Function Documentation

◆ accounts()

const std::vector< Easy::Account > Results::accounts ( ) const

Returns an array of matched Accounts.

Since
before 0.11.0
37 {
38  const Json::Value node = get("accounts");
39  if (node.isArray())
40  {
41  std::vector<Easy::Account> vec;
42  std::transform(node.begin(), node.end(), std::back_inserter(vec),
43  [](const Json::Value &value)
44  { return Easy::Account(value); });
45  return vec;
46  }
47 
48  return {};
49 }
Class to hold accounts.
Definition: account.hpp:46

◆ Entity() [1/3]

Easy::Entity::Entity

Constructs an empty Entity object.

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

◆ Entity() [2/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 {}

◆ Entity() [3/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

◆ hashtags_v1()

const std::vector< string > Results::hashtags_v1 ( ) const

Returns an array of matched hashtags as string.

Since
0.16.0
67 {
68  return get_vector("hashtags");
69 }
const std::vector< string > get_vector(const string &key) const
Returns the value of key as vector.
Definition: entity.cpp:249

◆ hashtags_v2()

const std::vector< Easy::Tag > Results::hashtags_v2 ( ) const

Returns an array of matched hashtags as Easy::Tag.

Since
0.16.0
72 {
73  const Json::Value node = get("hashtags");
74  if (node.isArray())
75  {
76  std::vector<Easy::Tag> vec;
77  std::transform(node.begin(), node.end(), std::back_inserter(vec),
78  [](const Json::Value &value)
79  { return Easy::Tag(value); });
80  return vec;
81  }
82 
83  return {};
84 }
Class to hold tags.
Definition: tag.hpp:44

◆ statuses()

const std::vector< Easy::Status > Results::statuses ( ) const

Returns an array of matched Statuses.

Since
before 0.11.0
52 {
53  const Json::Value node = get("statuses");
54  if (node.isArray())
55  {
56  std::vector<Easy::Status> vec;
57  std::transform(node.begin(), node.end(), std::back_inserter(vec),
58  [](const Json::Value &value)
59  { return Easy::Status(value); });
60  return vec;
61  }
62 
63  return {};
64 }
Class to hold statuses.
Definition: status.hpp:59

◆ valid()

bool Results::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.

25 {
26  const std::vector<string> attributes =
27  {{
28  "accounts",
29  "statuses",
30  "hashtags"
31  }};
32 
33  return Entity::check_valid(attributes);
34 }
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: