Mastodon::Easy::Relationship Class Reference

Class to hold relationships. More...

#include <relationship.hpp>

Inheritance diagram for Mastodon::Easy::Relationship:

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...
uint_fast64_t	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

json	JSON string

Since

before 0.11.0

: Entity(json)
{}

Relationship() [2/2]

Relationship::Relationship

(

)

Constructs an empty Relationship object.

Since

before 0.11.0

: Entity()
{}

Member Function Documentation

blocking()

bool Relationship::blocking

(

)

const

Returns true if the user is blocking the account.

Since

before 0.11.0

{
    return get_bool("blocking");
}

domain_blocking()

bool Relationship::domain_blocking

(

)

const

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

Since

before 0.11.0

{
    return get_bool("domain_blocking");
}

endorsed()

bool Relationship::endorsed

(

)

const

Returns true if the account is endorsed by the user.

Since

0.19.0

{
    return get_bool("endorsed");
}

followed_by()

bool Relationship::followed_by

(

)

const

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

Since

before 0.11.0

{
    return get_bool("followed_by");
}

following()

bool Relationship::following

(

)

const

Returns true if the user is being following the account.

Since

before 0.11.0

{
    return get_bool("following");
}

id()

uint_fast64_t Relationship::id

(

)

const

Returns the target account ID.

Since

before 0.11.0

{
    return stouint64(get_string("id"));
}

muting()

bool Relationship::muting

(

)

const

Returns true if the user is muting the account.

Since

before 0.11.0

{
    return get_bool("muting");
}

muting_notifications()

bool Relationship::muting_notifications

(

)

const

Returns true if the user is also muting notifications.

Since

before 0.11.0

{
    return get_bool("muting_notifications");
}

requested()

bool Relationship::requested

(

)

const

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

Since

before 0.11.0

{
    return get_bool("requested");
}

showing_notifications()

bool Relationship::showing_notifications

(

)

const

Returns true if the user is showing notifications.

Since

0.19.0

{
    return get_bool("showing_notifications");
}

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.

{
    const std::vector<string> attributes =
    {{
        "id",
        "following",
        "followed_by",
        "blocking",
        "muting",
        "muting_notifications",
        "requested",
        "domain_blocking"
    }};

    return Entity::check_valid(attributes);
}

---

The documentation for this class was generated from the following files:

• src/easy/entities/relationship.hpp
• src/easy/entities/relationship.cpp