Mastodon::Easy::Token Class Reference

Class to hold applications. More...

#include <token.hpp>

Inheritance diagram for Mastodon::Easy::Token:

Public Member Functions
virtual bool	valid () const override
	Returns true if the Entity holds valid data. More...
const string	access_token () const
	Returns the access token. More...
const string	token_type () const
	Returns the token type. More...
const string	scope () const
	Returns the scope of the token. More...
const Easy::time_type	created_at () const
	Returns the date of creation. 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 applications.

Since

before 0.11.0

Member Function Documentation

access_token()

const string Token::access_token

(

)

const

Returns the access token.

Since

0.103.0

{
    return get_string("access_token");
}

created_at()

const Easy::time_type Token::created_at

(

)

const

Returns the date of creation.

Since

0.103.0

{
    return get_time("created_at");
}

Entity() [1/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)
{}

Entity() [2/3]

Easy::Entity::Entity

Constructs an empty Entity object.

Since

before 0.11.0

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

Entity() [3/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);
}

scope()

const string Token::scope

(

)

const

Returns the scope of the token.

Since

0.103.0

{
    return get_string("scope");
}

token_type()

const string Token::token_type

(

)

const

Returns the token type.

Since

0.103.0

{
    return get_string("token_type");
}

valid()

bool Token::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(
        {
            "access_token",
            "token_type",
            "scope",
            "created_at"
        });
}

---

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

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