Mastodon::Easy::Account Class Reference

Class to hold accounts. More...

#include <account.hpp>

Inheritance diagram for Mastodon::Easy::Account:

Classes
class	Source
	Class to hold source attribute. More...

Public Types
using	fields_pair = std::pair< const string, const string >
	Describes a field. Format: name, value. More...

Public Member Functions
	Account (const string &json)
	Constructs an Account object from a JSON string. More...
	Account ()
	Constructs an empty Account object. More...
virtual const bool	valid () const
	Returns true if the Entity holds valid data. More...
const string	acct () const
	Returns username. More...
const string	avatar () const
	Returns URL of avatar. More...
Account	avatar (const string &avatar)
	Sets avatar. More...
const string	avatar_static () const
	Returns URL of static avatar. More...
const bool	bot () const
	Returns true if the account performs automated actions. More...
const system_clock::time_point	created_at () const
	Returns time of creation. More...
const string	display_name () const
	Returns display name. More...
Account	display_name (const string &display_name)
	Sets display name. More...
const std::vector< fields_pair >	fields () const
	Returns metadata fields. More...
Account	fields (std::vector< fields_pair > &fields)
	Sets metadata fields. More...
const uint_fast64_t	followers_count () const
	Returns number of followers. More...
const uint_fast64_t	following_count () const
	Returns number of people this account follows. More...
const string	header () const
	Returns URL of header image. More...
Account	header (const string &header)
	Sets header image. More...
const string	header_static () const
	Returns URL of static header image. More...
const uint_fast64_t	id () const
	Returns account-ID. More...
const bool	locked () const
	Returns true if the account is locked. More...
Account	locked (const bool &locked)
	Sets locked state. More...
const bool	has_moved () const
	Returns true if the account has been moved. More...
const Account	moved () const
	If the owner decided to switch accounts, new account is in this attribute. More...
const string	note () const
	Returns note. More...
Account	note (const string &note)
	Sets note. More...
const string	note_plain () const
	Returns plaintext version of note. More...
const visibility_type	privacy () const
	Returns default privacy of new toots. More...
const bool	sensitive () const
	Returns if media is marked as sensitive by default. More...
const Source	source () const
Account	source (const Source &source)
const uint_fast64_t	statuses_count () const
	Returns number of statuses. More...
const string	url () const
	Returns URL of the profile. More...
const string	username () const
	Returns username (without ) 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 accounts.

Since

before 0.11.0

Member Typedef Documentation

fields_pair

using Mastodon::Easy::Account::fields_pair = std::pair<const string, const string>

Describes a field. Format: name, value.

Since

0.16.1

Constructor & Destructor Documentation

Account() [1/2]

Account::Account ( const string &  json )

explicit

Constructs an Account object from a JSON string.

Parameters

json	JSON string

Since

before 0.11.0

: Entity(json)
{}

Account() [2/2]

Account::Account

(

)

Constructs an empty Account object.

Since

before 0.11.0

: Entity()
{}

Member Function Documentation

acct()

const string Account::acct

(

)

const

Returns username.

username for users on the same instance, user@hostname for users on other instances.

Since

before 0.11.0

{
    return get_string("acct");
}

avatar() [1/2]

const string Account::avatar

(

)

const

Returns URL of avatar.

Since

before 0.11.0

{
    return get_string("avatar");
}

avatar() [2/2]

Account Account::avatar

(

const string &

avatar

)

Sets avatar.

Filename or base64-encoded

Since

0.18.5

{
    set("avatar", Json::Value(avatar));
    return *this;
}

avatar_static()

const string Account::avatar_static

(

)

const

Returns URL of static avatar.

Since

before 0.11.0

{
    return get_string("avatar_static");
}

bot()

const bool Account::bot

(

)

const

Returns true if the account performs automated actions.

Since

0.16.0

{
    return get_bool("bot");
}

created_at()

const system_clock::time_point Account::created_at

(

)

const

Returns time of creation.

Since

before 0.11.0

{
    return get_time_point("created_at");
}

display_name() [1/2]

const string Account::display_name

(

)

const

Returns display name.

Since

before 0.11.0

{
    return get_string("display_name");
}

display_name() [2/2]

Account Account::display_name

(

const string &

display_name

)

Sets display name.

Since

0.18.5

{
    set("display_name", Json::Value(display_name));
    return *this;
}

fields() [1/2]

const std::vector< Account::fields_pair > Account::fields

(

)

const

Returns metadata fields.

Since

0.16.1

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

    if (node.isArray())
    {
        std::vector<Account::fields_pair> vec;
        for (const Json::Value &value : node)
        {
            vec.push_back(Account::fields_pair(value["name"].asString(),
                                               value["value"].asString()));
        }
        return vec;
    }

    return {};
}

fields() [2/2]

Account Mastodon::Easy::Account::fields

(

std::vector< fields_pair > &

fields

)

Sets metadata fields.

Since

0.18.5

followers_count()

const std::uint_fast64_t Account::followers_count

(

)

const

Returns number of followers.

Since

before 0.11.0

{
    return get_uint64("followers_count");
}

following_count()

const std::uint_fast64_t Account::following_count

(

)

const

Returns number of people this account follows.

Since

before 0.11.0

{
    return get_uint64("following_count");
}

has_moved()

const bool Account::has_moved

(

)

const

Returns true if the account has been moved.

Since

before 0.11.0

{
    if (get("moved").isObject())
    {
        return true;
    }

    return false;
}

header() [1/2]

const string Account::header

(

)

const

Returns URL of header image.

Since

before 0.11.0

{
    return get_string("header");
}

header() [2/2]

Account Account::header

(

const string &

header

)

Sets header image.

Filename or base64-encoded.

Since

0.18.5

{
    set("header", Json::Value(header));
    return *this;
}

header_static()

const string Account::header_static

(

)

const

Returns URL of static header image.

Since

before 0.11.0

{
    return get_string("header_static");
}

id()

const std::uint_fast64_t Account::id

(

)

const

Returns account-ID.

Since

before 0.11.0

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

locked() [1/2]

const bool Account::locked

(

)

const

Returns true if the account is locked.

Since

before 0.11.0

{
    return get_bool("locked");
}

locked() [2/2]

Account Account::locked

(

const bool &

locked

)

Sets locked state.

Since

0.18.5

{
    set("locked", Json::Value(locked));
    return *this;
}

moved()

const Account Account::moved

(

)

const

If the owner decided to switch accounts, new account is in this attribute.

Since

before 0.11.0

{
    if (has_moved())
    {
        // TODO: Find an account with moved-node and test
        return Account(get("moved").toStyledString());
    }

    return Account();
}

note() [1/2]

const string Account::note

(

)

const

Returns note.

Since

before 0.11.0

{
    return get_string("note");
}

note() [2/2]

Account Account::note

(

const string &

note

)

Sets note.

Since

0.18.5

{
    set("note", Json::Value(note));
    return *this;
}

note_plain()

const string Account::note_plain

(

)

const

Returns plaintext version of note.

Since

before 0.11.0

{
    return get_string("source.note");
}

privacy()

const Easy::visibility_type Account::privacy

(

)

const

Returns default privacy of new toots.

Since

before 0.11.0

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

    ttdebug << "Could not get data: source.privacy\n";
    return visibility_type::Undefined;
}

sensitive()

const bool Account::sensitive

(

)

const

Returns if media is marked as sensitive by default.

Since

before 0.11.0

{
    return get_bool("source.sensitive");
}

statuses_count()

const std::uint_fast64_t Account::statuses_count

(

)

const

Returns number of statuses.

Since

before 0.11.0

{
    return get_uint64("statuses_count");
}

url()

const string Account::url

(

)

const

Returns URL of the profile.

Since

before 0.11.0

{
    return get_string("url");
}

username()

const string Account::username

(

)

const

Returns username (without )

Since

before 0.11.0

{
    return get_string("username");
}

valid()

const bool Account::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",
        "username",
        "acct",
        "display_name",
        "locked",
        "created_at",
        "followers_count",
        "following_count",
        "statuses_count",
        "note",
        "url",
        "avatar",
        "avatar_static",
        "header",
        "header_static"
    }};

    return Entity::check_valid(attributes);
}

---

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

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