mastodon-cpp  0.30.1
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

 Results (const string &json)
 Constructs a Results object from a JSON string. More...
 
 Results ()
 Constructs an empty Results object. More...
 
virtual bool valid () const
 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...
 
const std::vector< string > hashtags () const
 Alias for hashtags_v1. 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 results.

Since
before 0.11.0

Constructor & Destructor Documentation

◆ Results() [1/2]

Results::Results ( const string &  json)
explicit

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

◆ Results() [2/2]

Results::Results ( )

Constructs an empty Results object.

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

Member Function Documentation

◆ accounts()

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

Returns an array of matched Accounts.

Since
before 0.11.0
44 {
45  const Json::Value node = get("accounts");
46  if (node.isArray())
47  {
48  std::vector<Easy::Account> vec;
49  for (const Json::Value &value : node)
50  {
51  vec.push_back(Easy::Account(value.toStyledString()));
52  }
53  return vec;
54  }
55 
56  return {};
57 }
Class to hold accounts.
Definition: account.hpp:46

◆ hashtags()

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

Alias for hashtags_v1.

Since
before 0.11.0
97 {
98  return hashtags_v1();
99 }
const std::vector< string > hashtags_v1() const
Returns an array of matched hashtags as string.
Definition: results.cpp:75

◆ hashtags_v1()

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

Returns an array of matched hashtags as string.

Since
0.16.0
76 {
77  return get_vector("hashtags");
78 }
const std::vector< string > get_vector(const string &key) const
Returns the value of key as vector.
Definition: entity.cpp:210

◆ hashtags_v2()

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

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

Since
0.16.0
81 {
82  const Json::Value node = get("hashtags");
83  if (node.isArray())
84  {
85  std::vector<Easy::Tag> vec;
86  for (const Json::Value &value : node)
87  {
88  vec.push_back(Easy::Tag(value.toStyledString()));
89  }
90  return vec;
91  }
92 
93  return {};
94 }
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
60 {
61  const Json::Value node = get("statuses");
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  return {};
73 }
Class to hold statuses.
Definition: status.hpp:59

◆ valid()

bool Results::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  "accounts",
36  "statuses",
37  "hashtags"
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: