Class to hold accounts. More...

#include <account.hpp>

Inheritance diagram for Mastodon::Easy::Account:

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.

const string	acct () const
	Returns username. More...

const string	avatar () const
	Returns URL of avatar.

const string	avatar_static () const
	Returns URL of static avatar.

const bool	bot () const
	Returns true if the account performs automated actions.

const system_clock::time_point	created_at () const
	Returns time of creation.

const string	display_name () const
	Returns display name.

const std::vector< fields_pair >	fields () const
	Returns metadata fields. More...

const uint_fast64_t	followers_count () const
	Returns number of followers.

const uint_fast64_t	following_count () const
	Returns number of people this account follows.

const string	header () const
	Returns URL of header image.

const string	header_static () const
	Returns URL of static header image.

const uint_fast64_t	id () const
	Returns account-ID.

const bool	locked () const
	Returns true if the account is locked.

const bool	has_moved () const
	Returns true if the account has been moved.

const Account	moved () const
	If the owner decided to switch accounts, new account is in this attribute.

const string	note () const
	Returns note.

const string	note_plain () const
	Returns plaintext version of note.

const visibility_type	privacy () const
	Returns default privacy of new toots.

const bool	sensitive () const
	Returns if media is marked as sensitive by default.

const uint_fast64_t	statuses_count () const
	Returns number of statuses.

const string	url () const
	Returns URL of the profile.

const string	username () const
	Returns username (without )

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.

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 bool	valid () const
	Returns true if the Entity holds valid data.

const string	error () const
	Returns error string sent by the server.

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 std::uint_fast64_t	stouint64 (const string &str) const

Detailed Description

Class to hold accounts.

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()

Account::Account ( const string & json )

explicit

Constructs an Account object from a JSON string.

Parameters

json	JSON string

24 : Entity(json)

25 {}

Mastodon::Easy::Entity::Entity

Entity()

Constructs an empty Entity object.

Definition: entity.cpp:70

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.

 {
     return get_string("acct");
 }

◆ fields()

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 {};
 }

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

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

Public Types

Public Member Functions

Additional Inherited Members