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
	Source (const string &json)
	Constructs an Account::Source object from a JSON string. More...
	Source ()
	Constructs an empty Account::Source object. More...
virtual bool	valid () const
	Returns true if the Entity holds valid data. More...
const std::vector< fields_pair >	fields () const
	Returns metadata fields. More...
Source	fields (std::vector< fields_pair > &fields)
	Sets metadata fields. More...
const string	note () const
	Returns note in plain text. More...
Source	note (const string &note)
	Sets note. More...
visibility_type	privacy () const
	Returns default privacy of new toots. More...
Source	privacy (const visibility_type &privacy)
	Sets default privacy of new toots. More...
bool	sensitive () const
	Returns if media is marked as sensitive by default. More...
Source	sensitive (const bool &sensitive)
	Sets if media is marked as sensitive by default. 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 source attribute.

Since

0.18.5

Constructor & Destructor Documentation

Source() [1/2]

Account::Source::Source ( const string &  json )

explicit

Constructs an Account::Source object from a JSON string.

Parameters

json	JSON string

Since

0.18.5

: Entity(json)
{}

Source() [2/2]

Account::Source::Source

(

)

Constructs an empty Account::Source object.

Since

0.18.5

: Entity()
{}

Member Function Documentation

fields() [1/2]

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

(

)

const

Returns metadata fields.

Since

0.18.5

{
    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]

Source Mastodon::Easy::Account::Source::fields

(

std::vector< fields_pair > &

fields

)

Sets metadata fields.

Since

0.18.5

note() [1/2]

const string Account::Source::note

(

)

const

Returns note in plain text.

Since

0.18.5

{
    return get_string("note");
}

note() [2/2]

Account::Source Account::Source::note

(

const string &

note

)

Sets note.

Since

0.18.5

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

privacy() [1/2]

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

privacy() [2/2]

Account::Source Account::Source::privacy

(

const visibility_type &

privacy

)

Sets default privacy of new toots.

Since

0.18.5

{
    string strprivacy = "";
    switch (privacy)
    {
        case visibility_type::Public:
        {
            strprivacy = "public"; 
            break;
        }
        case visibility_type::Unlisted:
        {
            strprivacy = "unlisted"; 
            break;
        }
        case visibility_type::Private:
        {
            strprivacy = "private"; 
            break;
        }
        case visibility_type::Direct:
        {
            strprivacy = "direct"; 
            break;
        }
        default:
        {
            strprivacy = "undefined"; 
            break;
        }
    }
    set("privacy", Json::Value(strprivacy));
    return *this;
}

sensitive() [1/2]

bool Account::Source::sensitive

(

)

const

Returns if media is marked as sensitive by default.

Since

0.18.5

{
    return get_bool("sensitive");
}

sensitive() [2/2]

Account::Source Account::Source::sensitive

(

const bool &

sensitive

)

Sets if media is marked as sensitive by default.

Since

0.18.5

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

valid()

bool Account::Source::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.

{
    return true;
}

---

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

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