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

Class to hold relationships. More...

#include <relationship.hpp>

Inheritance diagram for Mastodon::Easy::Relationship:
Mastodon::Easy::Entity

Public Member Functions

 Relationship (const string &json)
 Constructs a Relationship object from a JSON string. More...
 
 Relationship ()
 Constructs an empty Relationship object. More...
 
virtual bool valid () const
 Returns true if the Entity holds valid data. More...
 
bool blocking () const
 Returns true if the user is blocking the account. More...
 
bool domain_blocking () const
 Returns true if the user is blocking the account's domain. More...
 
bool endorsed () const
 Returns true if the account is endorsed by the user. More...
 
bool followed_by () const
 Returns true if the user is being followed by the account. More...
 
bool following () const
 Returns true if the user is being following the account. More...
 
const string id () const
 Returns the target account ID. More...
 
bool muting () const
 Returns true if the user is muting the account. More...
 
bool muting_notifications () const
 Returns true if the user is also muting notifications. More...
 
bool requested () const
 Returns true if the user has requested to follow the account. More...
 
bool showing_notifications () const
 Returns true if the user is showing notifications. 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 relationships.

before 0.11.0

Constructor & Destructor Documentation

◆ Relationship() [1/2]

Relationship::Relationship ( const string &  json)
explicit

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

◆ Relationship() [2/2]

Relationship::Relationship ( )

Constructs an empty Relationship object.

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

Member Function Documentation

◆ blocking()

bool Relationship::blocking ( ) const

Returns true if the user is blocking the account.

Since
before 0.11.0
48 {
49  return get_bool("blocking");
50 }
bool get_bool(const string &key) const
Returns the value of key as bool.
Definition: entity.cpp:176

◆ domain_blocking()

bool Relationship::domain_blocking ( ) const

Returns true if the user is blocking the account's domain.

Since
before 0.11.0
53 {
54  return get_bool("domain_blocking");
55 }
bool get_bool(const string &key) const
Returns the value of key as bool.
Definition: entity.cpp:176

◆ endorsed()

bool Relationship::endorsed ( ) const

Returns true if the account is endorsed by the user.

Since
0.19.0
58 {
59  return get_bool("endorsed");
60 }
bool get_bool(const string &key) const
Returns the value of key as bool.
Definition: entity.cpp:176

◆ followed_by()

bool Relationship::followed_by ( ) const

Returns true if the user is being followed by the account.

Since
before 0.11.0
63 {
64  return get_bool("followed_by");
65 }
bool get_bool(const string &key) const
Returns the value of key as bool.
Definition: entity.cpp:176

◆ following()

bool Relationship::following ( ) const

Returns true if the user is being following the account.

Since
before 0.11.0
68 {
69  return get_bool("following");
70 }
bool get_bool(const string &key) const
Returns the value of key as bool.
Definition: entity.cpp:176

◆ id()

const string Relationship::id ( ) const

Returns the target account ID.

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

◆ muting()

bool Relationship::muting ( ) const

Returns true if the user is muting the account.

Since
before 0.11.0
78 {
79  return get_bool("muting");
80 }
bool get_bool(const string &key) const
Returns the value of key as bool.
Definition: entity.cpp:176

◆ muting_notifications()

bool Relationship::muting_notifications ( ) const

Returns true if the user is also muting notifications.

Since
before 0.11.0
83 {
84  return get_bool("muting_notifications");
85 }
bool get_bool(const string &key) const
Returns the value of key as bool.
Definition: entity.cpp:176

◆ requested()

bool Relationship::requested ( ) const

Returns true if the user has requested to follow the account.

Since
before 0.11.0
88 {
89  return get_bool("requested");
90 }
bool get_bool(const string &key) const
Returns the value of key as bool.
Definition: entity.cpp:176

◆ showing_notifications()

bool Relationship::showing_notifications ( ) const

Returns true if the user is showing notifications.

Since
0.19.0
93 {
94  return get_bool("showing_notifications");
95 }
bool get_bool(const string &key) const
Returns the value of key as bool.
Definition: entity.cpp:176

◆ valid()

bool Relationship::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  "following",
36  "followed_by",
37  "blocking",
38  "muting",
39  "muting_notifications",
40  "requested",
41  "domain_blocking"
42  }};
43 
44  return Entity::check_valid(attributes);
45 }
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: