Mastodon::Easy::Notification Class Reference

Class to hold notifications. More...

#include <notification.hpp>

Inheritance diagram for Mastodon::Easy::Notification:

Public Member Functions
virtual bool	valid () const override
	Returns true if the Entity holds valid data. More...
const Account	account () const
	Returns the Account sending the notification to the user. More...
const Easy::time_type	created_at () const
	Returns time of creation. More...
const string	id () const
	Returns notification ID. More...
const Status	status () const
	Returns the Status associated with the notification, if applicable. More...
Easy::notification_type	type () const
	Returns notification type. 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 notifications.

Since

before 0.11.0

Examples

example02_stream.cpp.

Member Function Documentation

account()

const Easy::Account Notification::account

(

)

const

Returns the Account sending the notification to the user.

Since

before 0.11.0

Examples

example02_stream.cpp.

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

    ttdebug << "Could not get data: account\n";
    return Easy::Account();
}

created_at()

const Easy::time_type Notification::created_at

(

)

const

Returns time of creation.

Since

before 0.11.0

{
    return get_time("created_at");
}

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

Easy::Entity::Entity

Constructs an empty Entity object.

Since

before 0.11.0

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

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

id()

const string Notification::id

(

)

const

Returns notification ID.

Since

before 0.11.0

Examples

example02_stream.cpp.

{
    return get_string("id");
}

status()

const Easy::Status Notification::status

(

)

const

Returns the Status associated with the notification, if applicable.

Since

before 0.11.0

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

    ttdebug << "Could not get data: status\n";
    return Easy::Status();
}

type()

Easy::notification_type Notification::type

(

)

const

Returns notification type.

Since

before 0.11.0

{
    const string strtype = get_string("type");
    if (strtype.compare("mention") == 0)
        return notification_type::Mention;
    else if (strtype.compare("reblog") == 0)
        return notification_type::Reblog;
    else if (strtype.compare("favourite") == 0)
        return notification_type::Favourite;
    else if (strtype.compare("follow") == 0)
        return notification_type::Follow;

    return notification_type::Undefined;
}

valid()

bool Notification::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(
        {
            "id",
            "type",
            "created_at",
            "account"
        });
}

---

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

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