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...
const bool	blocking () const
	Returns true if the user is blocking the account. More...
const bool	domain_blocking () const
	Returns true if the user is blocking the account's domain. More...
const bool	followed_by () const
	Returns true if the user is being followed by the account. More...
const bool	following () const
	Returns true if the user is being following the account. More...
const uint_fast64_t	id () const
	Returns the target account ID. More...
const bool	muting () const
	Returns true if the user is muting the account. More...
const bool	muting_notifications () const
	Returns true if the user is also muting notifications. More...
const bool	requested () const
	Returns true if the user has requested to follow the account. 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...
const 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 bool	valid () const
	Returns true if the Entity holds valid data. More...
const string	error () const
	Returns error string sent by the server. More...
const 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...
const uint_fast64_t	get_uint64 (const string &key) const
	Returns the value of key as std::uint_fast64_t. More...
const double	get_double (const string &key) const
	Returns the value of key as double. More...
const 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...
const void	set (const string &key, const Json::Value &value)
	Sets the value of key. More...
const std::uint_fast64_t	stouint64 (const string &str) const

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

const bool Relationship::blocking

(

)

const

Returns true if the user is blocking the account.

Since

before 0.11.0

{
    return get_bool("blocking");
}

domain_blocking()

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

followed_by()

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

const 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 uint_fast64_t Relationship::id

(

)

const

Returns the target account ID.

Since

before 0.11.0

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

muting()

const bool Relationship::muting

(

)

const

Returns true if the user is muting the account.

Since

before 0.11.0

{
    return get_bool("muting");
}

muting_notifications()

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

const bool Relationship::requested

(

)

const

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

Since

before 0.11.0

{
    return get_bool("requested");
}

---

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

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