Mastodon::Easy::List Class Reference

Class to hold lists. More...

#include <list.hpp>

Inheritance diagram for Mastodon::Easy::List:

Public Member Functions
	List (const string &json)
	Constructs a List object from a JSON string. More...
	List ()
	Constructs an empty List object. More...
virtual bool	valid () const
	Returns true if the Entity holds valid data. More...
uint_fast64_t	id () const
	Returns list-ID. More...
const string	title () const
	Returns title. 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 lists.

Since

before 0.11.0

Constructor & Destructor Documentation

List() [1/2]

List::List ( const string &  json )

explicit

Constructs a List object from a JSON string.

Parameters

json	JSON string

Since

before 0.11.0

: Entity(json)
{}

List() [2/2]

List::List

(

)

Constructs an empty List object.

Since

before 0.11.0

: Entity()
{}

Member Function Documentation

id()

uint_fast64_t List::id

(

)

const

Returns list-ID.

Since

before 0.11.0

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

title()

const string List::title

(

)

const

Returns title.

Since

before 0.11.0

{
    return get_string("title");
}

valid()

bool List::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",
        "title"
    }};

    return Entity::check_valid(attributes);
}

---

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

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