Mastodon::Easy::Results Class Reference

Class to hold results. More...

#include <results.hpp>

Inheritance diagram for Mastodon::Easy::Results:

Public Member Functions
	Results (const string &json)
	Constructs a Results object from a JSON string. More...
	Results ()
	Constructs an empty Results object. More...
virtual const bool	valid () const
	Returns true if the Entity holds valid data. More...
const std::vector< Account >	accounts () const
	Returns an array of matched Accounts. More...
const std::vector< Status >	statuses () const
	Returns an array of matched Statuses. More...
const std::vector< string >	hashtags_v1 () const
	Returns an array of matched hashtags as string. More...
const std::vector< Tag >	hashtags_v2 () const
	Returns an array of matched hashtags as Easy::Tag. More...
const std::vector< string >	hashtags () const
	Alias for hashtags_v1. 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 results.

Since

before 0.11.0

Constructor & Destructor Documentation

Results() [1/2]

Results::Results ( const string &  json )

explicit

Constructs a Results object from a JSON string.

Parameters

json	JSON string

Since

before 0.11.0

: Entity(json)
{}

Results() [2/2]

Results::Results

(

)

Constructs an empty Results object.

Since

before 0.11.0

: Entity()
{}

Member Function Documentation

accounts()

const std::vector< Easy::Account > Results::accounts

(

)

const

Returns an array of matched Accounts.

Since

before 0.11.0

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

    return {};
}

hashtags()

const std::vector< string > Results::hashtags

(

)

const

Alias for hashtags_v1.

Since

before 0.11.0

{
    return hashtags_v1();
}

hashtags_v1()

const std::vector< string > Results::hashtags_v1

(

)

const

Returns an array of matched hashtags as string.

Since

0.16.0

{
    return get_vector("hashtags");
}

hashtags_v2()

const std::vector< Easy::Tag > Results::hashtags_v2

(

)

const

Returns an array of matched hashtags as Easy::Tag.

Since

0.16.0

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

    return {};
}

statuses()

const std::vector< Easy::Status > Results::statuses

(

)

const

Returns an array of matched Statuses.

Since

before 0.11.0

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

    return {};
}

valid()

const bool Results::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 =
    {{
        "accounts",
        "statuses",
        "hashtags"
    }};

    return Entity::check_valid(attributes);
}

---

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

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