Mastodon::Easy::Account::Source Class Reference

Class to hold source attribute. More...

#include <account.hpp>

Inheritance diagram for Mastodon::Easy::Account::Source:

Public Member Functions
virtual bool	valid () const override
	Returns true if the Entity holds valid data. More...
const vector< Easy::account_field_type >	fields () const
	Returns metadata fields. More...
const string	language () const
	Returns the language as ISO 6391 string. More...
const string	note () const
	Returns account description in plain text. More...
visibility_type	privacy () const
	Returns default privacy of new toots. More...
bool	sensitive () const
	Returns if media is marked as sensitive by default. 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 source attribute.

Since

0.18.5

Member Function Documentation

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

Entity() [2/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() [3/3]

Easy::Entity::Entity

Constructs an empty Entity object.

Since

before 0.11.0

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

fields()

const vector< Easy::account_field_type > Account::Source::fields

(

)

const

Returns metadata fields.

Since

0.18.5

{
    const Json::Value &node = get("fields");

    if (node.isArray())
    {
        vector<Easy::account_field_type> vec;
        std::transform(node.begin(), node.end(), std::back_inserter(vec),
                       [](const Json::Value &value)
                       {
                           return Easy::account_field_type(
                               {
                                   value["name"].asString(),
                                   value["value"].asString(),
                                   Easy::string_to_time(
                                       value["verified_at"].asString())
                               });
                           });
        return vec;
    }

    return {};
}

language()

const string Account::Source::language

(

)

const

Returns the language as ISO 6391 string.

Since

0.106.0

{
    return get_string("language");
}

note()

const string Account::Source::note

(

)

const

Returns account description in plain text.

Since

0.18.5

{
    return get_string("note");
}

privacy()

Easy::visibility_type Account::Source::privacy

(

)

const

Returns default privacy of new toots.

Since

0.18.5

{
    const string strprivacy = get_string("privacy");
    if (strprivacy == "public")
        return visibility_type::Public;
    else if (strprivacy == "unlisted")
        return visibility_type::Unlisted;
    else if (strprivacy == "private")
        return visibility_type::Private;
    else if (strprivacy == "direct")
        return visibility_type::Direct;

    return visibility_type::Undefined;
}

sensitive()

bool Account::Source::sensitive

(

)

const

Returns if media is marked as sensitive by default.

Since

0.18.5

{
    return get_bool("sensitive");
}

valid()

bool Account::Source::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(
        {
            "note",
            "fields"
        });
}

---

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

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