Mastodon::Easy::Relationship Class Reference

Class to hold relationships. More...

#include <relationship.hpp>

Inheritance diagram for Mastodon::Easy::Relationship:

Public Member Functions
virtual bool	valid () const override
	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...
bool	showing_reblogs () const
	Returns true if the user is showing reblogs. 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 formatted 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_type	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 relationships.

before 0.11.0

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");
}

Entity() [1/3]

Easy::Entity::Entity

Constructs an empty Entity object.

Since

before 0.11.0

: _tree(Json::nullValue)
, _was_set(false)
{}

Entity() [2/3]

Easy::Entity::Entity

explicit

Constructs an Entity object from a JSON string.

Parameters

json	JSON string

Since

before 0.11.0

: _tree(Json::nullValue)
,_was_set(false)
{
    from_string(json);
}

Entity() [3/3]

Easy::Entity::Entity

explicit

Constructs an Entity object from a JSON object.

Parameters

object

JSON object

Since

0.100.0

: _tree(object)
,_was_set(false)
{}

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()

const string Relationship::id

(

)

const

Returns the target account ID.

Since

before 0.11.0

{
    return 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");
}

showing_reblogs()

bool Relationship::showing_reblogs

(

)

const

Returns true if the user is showing reblogs.

Since

0.106.0

{
    return get_bool("showing_reblogs");
}

valid()

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

{
    return Entity::check_valid(
        {
            "id",
            "following",
            "followed_by",
            "blocking",
            "muting",
            "muting_notifications",
            "requested",
            "domain_blocking",
            "showing_reblogs",
            "endorsed"
        });
}

---

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

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