Mastodon::Easy::Status Class Reference

Class to hold statuses. More...

#include <status.hpp>

Inheritance diagram for Mastodon::Easy::Status:

Public Member Functions
	Status (const string &json)
	Constructs a Status object from a JSON string. More...
	Status ()
	Constructs an empty Status object. More...
virtual const bool	valid () const
	Returns true if the Entity holds valid data. More...
const Account	account () const
	Returns an array of matched accounts. More...
const Application	application () const
	Returns application from which the status was posted. More...
const system_clock::time_point	created_at () const
	Returns time of creation. More...
const string	content () const
	Returns content of status. More...
Status	content (const string &content)
	Sets content of status. More...
const std::vector< Emoji >	emojis () const
	Returns an array of emojis. More...
const bool	favourited () const
	Returns true if the user has favourited the status. More...
const uint_fast64_t	favourites_count () const
	Returns the number of favourites. More...
const uint_fast64_t	id () const
	Returns the ID of the status. More...
const uint_fast64_t	in_reply_to_id () const
	Returns the ID of the status it replies to. More...
Status	in_reply_to_id (const uint_fast64_t &in_reply_to_id)
	Sets the ID of the status it replies to. More...
const uint_fast64_t	in_reply_to_account_id () const
	Returns the ID of the account it replies to. More...
const string	language () const
	Returns the language of the status. More...
Status	language (const string &language)
	Sets the language of the status. More...
const std::vector< Attachment >	media_attachments () const
	Returns the attachments. More...
Status	media_attachments (const std::vector< Attachment > &media_attachments)
	Sets the attachments. More...
const std::vector< Mention >	mentions () const
	Returns the mentions. More...
const bool	muted () const
	Returns true if the user muted the conversation. More...
const bool	pinned () const
	Returns true if the status is pinned. More...
const Status	reblog () const
	Returns the reblogged Status. More...
const bool	reblogged () const
	Returns true if the user has reblogged the status. More...
const uint_fast64_t	reblogs_count () const
	Returns the number of reblogs for the status. More...
const bool	sensitive () const
	Returns true if the attachments should be hidden by default. More...
Status	sensitive (const bool &sensitive)
	Sets sensitive flag for attachments. More...
const string	spoiler_text () const
	Returns the spoiler text. More...
Status	spoiler_text (const string &spoiler_text)
	Sets the spoiler text. More...
const std::vector< Tag >	tags () const
	Returns the tags. More...
const string	uri () const
	Returns the Fediverse-unique resource ID. More...
const string	url () const
	Returns the URL to the status page. More...
const visibility_type	visibility () const
	Returns the visibility of the status. More...
Status	visibility (const visibility_type &visibility)
	Sets the visibility of the status. 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 statuses.

Since

before 0.11.0

Constructor & Destructor Documentation

Status() [1/2]

Status::Status ( const string &  json )

explicit

Constructs a Status object from a JSON string.

Parameters

json	JSON string

Since

before 0.11.0

: Entity(json)
{}

Status() [2/2]

Status::Status

(

)

Constructs an empty Status object.

Since

before 0.11.0

: Entity()
{}

Member Function Documentation

account()

const Easy::Account Status::account

(

)

const

Returns an array of matched accounts.

Since

before 0.11.0

{
    const Json::Value node = get("account");
    if (node.isObject())
    {
        return Easy::Account(node.toStyledString());
    }

    return Easy::Account();
}

application()

const Easy::Application Status::application

(

)

const

Returns application from which the status was posted.

Since

before 0.11.0

{
    const Json::Value node = get("application");
    if (node.isObject())
    {
        return Easy::Application(node.toStyledString());
    }

    return Easy::Application();
}

content() [1/2]

const string Status::content

(

)

const

Returns content of status.

Since

before 0.11.0

{
    return get_string("content");
}

content() [2/2]

Status Status::content

(

const string &

content

)

Sets content of status.

Since

0.17.0

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

created_at()

const system_clock::time_point Status::created_at

(

)

const

Returns time of creation.

Since

before 0.11.0

{
    return get_time_point("created_at");
}

emojis()

const std::vector< Easy::Emoji > Status::emojis

(

)

const

Returns an array of emojis.

Since

before 0.11.0

{
    const Json::Value node = get("emojis");
    if (node.isArray())
    {
        std::vector<Easy::Emoji> vec;
        for (const Json::Value &value : node)
        {
            vec.push_back(Easy::Emoji(value.toStyledString()));
        }
        return vec;
    }

    return {};
}

favourited()

const bool Status::favourited

(

)

const

Returns true if the user has favourited the status.

Since

before 0.11.0

{
    return get_bool("favourited");
}

favourites_count()

const uint_fast64_t Status::favourites_count

(

)

const

Returns the number of favourites.

Since

before 0.11.0

{
    return get_uint64("favourites_count");
}

id()

const uint_fast64_t Status::id

(

)

const

Returns the ID of the status.

Since

before 0.11.0

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

in_reply_to_account_id()

const uint_fast64_t Status::in_reply_to_account_id

(

)

const

Returns the ID of the account it replies to.

Since

before 0.11.0

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

in_reply_to_id() [1/2]

const uint_fast64_t Status::in_reply_to_id

(

)

const

Returns the ID of the status it replies to.

Since

before 0.11.0

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

in_reply_to_id() [2/2]

Status Status::in_reply_to_id

(

const uint_fast64_t &

in_reply_to_id

)

Sets the ID of the status it replies to.

Since

0.17.0

{
    set("in_reply_to_id", Json::Value(std::to_string(in_reply_to_id)));
    return *this;
}

language() [1/2]

const string Status::language

(

)

const

Returns the language of the status.

Since

before 0.11.0

{
    return get_string("language");
}

language() [2/2]

Status Status::language

(

const string &

language

)

Sets the language of the status.

Since

0.17.0

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

media_attachments() [1/2]

const std::vector< Easy::Attachment > Status::media_attachments

(

)

const

Returns the attachments.

Since

before 0.11.0

{
    const Json::Value node = get("media_attachments");
    if (node.isArray())
    {
        std::vector<Easy::Attachment> vec;
        for (const Json::Value &value : node)
        {
            vec.push_back(Easy::Attachment(value.toStyledString()));
        }
        return vec;
    }

    return {};
}

media_attachments() [2/2]

Status Status::media_attachments

(

const std::vector< Attachment > &

media_attachments

)

Sets the attachments.

Since

0.17.0

{
    // FIXME: Needs writable Easy::Attachment()
    Json::Value jsonarray(Json::arrayValue);

    for (const Attachment &att : media_attachments)
    {
        jsonarray.append(att.to_object());
    }
    set("media_attachments", jsonarray);
    return *this;
}

mentions()

const std::vector< Easy::Mention > Status::mentions

(

)

const

Returns the mentions.

Since

before 0.11.0

{
    const Json::Value node = get("mentions");
    if (node.isArray())
    {
        std::vector<Easy::Mention> vec;
        for (const Json::Value &value : node)
        {
            vec.push_back(Easy::Mention(value.toStyledString()));
        }
        return vec;
    }

    return {};
}

muted()

const bool Status::muted

(

)

const

Returns true if the user muted the conversation.

Since

before 0.11.0

{
    return get_bool("muted");
}

pinned()

const bool Status::pinned

(

)

const

Returns true if the status is pinned.

Since

before 0.11.0

{
    return get_bool("pinned");
}

reblog()

const Status Status::reblog

(

)

const

Returns the reblogged Status.

Since

before 0.11.0

{
    const Json::Value node = get("reblog");
    if (node.isObject())
    {
        return Easy::Status(node.toStyledString());
    }

    return Easy::Status();
}

reblogged()

const bool Status::reblogged

(

)

const

Returns true if the user has reblogged the status.

Since

before 0.11.0

{
    return get_bool("reblogged");
}

reblogs_count()

const uint_fast64_t Status::reblogs_count

(

)

const

Returns the number of reblogs for the status.

Since

before 0.11.0

{
    return get_uint64("reblogs_count");
}

sensitive() [1/2]

const bool Status::sensitive

(

)

const

Returns true if the attachments should be hidden by default.

Since

before 0.11.0

{
    return get_bool("sensitive");
}

sensitive() [2/2]

Status Status::sensitive

(

const bool &

sensitive

)

Sets sensitive flag for attachments.

Since

0.17.0

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

spoiler_text() [1/2]

const string Status::spoiler_text

(

)

const

Returns the spoiler text.

Since

before 0.11.0

{
    return get_string("spoiler_text");
}

spoiler_text() [2/2]

Status Status::spoiler_text

(

const string &

spoiler_text

)

Sets the spoiler text.

Since

0.17.0

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

tags()

const std::vector< Easy::Tag > Status::tags

(

)

const

Returns the tags.

Since

before 0.11.0

{
    const Json::Value node = get("tags");
    if (node.isArray())
    {
        std::vector<Easy::Tag> vec;
        for (const Json::Value &value : node)
        {
            vec.push_back(Easy::Tag(value.toStyledString()));
        }
        return vec;
    }

    return {};
}

uri()

const string Status::uri

(

)

const

Returns the Fediverse-unique resource ID.

Since

before 0.11.0

{
    return get_string("uri");
}

url()

const string Status::url

(

)

const

Returns the URL to the status page.

Since

before 0.11.0

{
    return get_string("url");
}

valid()

const bool Status::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",
        "uri",
        "account",
        "content",
        "created_at",
        "emojis",
        "reblogs_count",
        "favourites_count",
        "sensitive",
        "spoiler_text",
        "visibility",
        "media_attachments",
        "mentions",
        "tags"
    }};

    return Entity::check_valid(attributes);
}

visibility() [1/2]

const Easy::visibility_type Status::visibility

(

)

const

Returns the visibility of the status.

Since

before 0.11.0

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

    return visibility_type::Undefined;
}

visibility() [2/2]

Status Status::visibility

(

const visibility_type &

visibility

)

Sets the visibility of the status.

Since

0.17.0

{
    switch (visibility)
    {
        case visibility_type::Direct:
            set("visibility", "direct");
            break;
        case visibility_type::Private:
            set("visibility", "private");
            break;
        case visibility_type::Unlisted:
            set("visibility", "unlisted");
            break;
        case visibility_type::Public:
            set("visibility", "public");
            break;
        default:
            std::cerr << "WARNING: setting visibility to Undefined "
                         "has no effect.\n";
            break;
    };
    return *this;
}

---

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

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