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

Class to hold reports. More...

#include <report.hpp>

Inheritance diagram for Mastodon::Easy::Report:
Mastodon::Easy::Entity

Public Member Functions

 Report (const string &json)
 Constructs a Report object from a JSON string. More...
 
 Report ()
 Constructs an empty Report object. More...
 
virtual bool valid () const
 Returns true if the Entity holds valid data. More...
 
bool action_taken () const
 Returns true if an action was taken in response to the report. More...
 
uint_fast64_t id () const
 Returns the ID of the report. 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 reports.

before 0.11.0

Constructor & Destructor Documentation

◆ Report() [1/2]

Report::Report ( const string &  json)
explicit

Constructs a Report object from a JSON string.

Parameters
jsonJSON string
Since
before 0.11.0
23 : Entity(json)
24 {}
Entity()
Constructs an empty Entity object.
Definition: entity.cpp:65

◆ Report() [2/2]

Report::Report ( )

Constructs an empty Report object.

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

Member Function Documentation

◆ action_taken()

bool Report::action_taken ( ) const

Returns true if an action was taken in response to the report.

Since
before 0.11.0
42 {
43  return get_bool("action_taken");
44 }
bool get_bool(const string &key) const
Returns the value of key as bool.
Definition: entity.cpp:176

◆ id()

uint_fast64_t Report::id ( ) const

Returns the ID of the report.

Since
before 0.11.0
47 {
48  return stouint64(get_string("id"));
49 }
const string get_string(const string &key) const
Returns the value of key as std::string.
Definition: entity.cpp:134

◆ valid()

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

31 {
32  const std::vector<string> attributes =
33  {{
34  "id",
35  "action_taken"
36  }};
37 
38  return Entity::check_valid(attributes);
39 }
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: