Mastodon::Easy::Context Class Reference

Class to hold contexts. More...

#include <context.hpp>

Inheritance diagram for Mastodon::Easy::Context:

Public Member Functions
	Context (const string &json)
	Constructs a Context object from a JSON string. More...
	Context ()
	Constructs an empty Context object. More...
virtual const bool	valid () const
	Returns true if the Entity holds valid data. More...
const std::vector< Status >	ancestors () const
	Returns the ancestors of the Status as vector of Statuses. More...
const std::vector< Status >	descendants () const
	Returns the descendants of the Status as vector of Statuses. 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 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
const bool	check_valid (const std::vector< string > &attributes) const
	Checks if an Entity is valid. More...

Detailed Description

Class to hold contexts.

Since

before 0.11.0

Constructor & Destructor Documentation

Context() [1/2]

Context::Context ( const string &  json )

explicit

Constructs a Context object from a JSON string.

Parameters

json	JSON string

Since

before 0.11.0

: Entity(json)
{}

Context() [2/2]

Context::Context

(

)

Constructs an empty Context object.

Since

before 0.11.0

: Entity()
{}

Member Function Documentation

ancestors()

const std::vector< Easy::Status > Context::ancestors

(

)

const

Returns the ancestors of the Status as vector of Statuses.

Since

before 0.11.0

{
    const Json::Value node = get("ancestors");
    if (node.isArray())
    {
        std::vector<Easy::Status> vec;
        for (const Json::Value &value : node)
        {
            vec.push_back(Easy::Status(value.toStyledString()));
        }
        return vec;
    }

    ttdebug << "Could not get data: ancestors\n";
    return {};
}

descendants()

const std::vector< Easy::Status > Context::descendants

(

)

const

Returns the descendants of the Status as vector of Statuses.

Since

before 0.11.0

{
    const Json::Value node = get("descendants");
    if (node.isArray())
    {
        std::vector<Easy::Status> vec;
        for (const Json::Value &value : node)
        {
            vec.push_back(Easy::Status(value.toStyledString()));
        }
        return vec;
    }

    ttdebug << "Could not get data: descendants\n";
    return {};
}

valid()

const bool Context::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 =
    {{
        "ancestors",
        "descendants"
    }};

    return Entity::check_valid(attributes);
}

---

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

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