Mastodon::Easy::PushSubscription Class Reference

Class to hold push subscriptions. More...

#include <pushsubscription.hpp>

Inheritance diagram for Mastodon::Easy::PushSubscription:

Public Member Functions
virtual bool	valid () const override
	Returns true if the Entity holds valid data. More...
const string	id () const
	Returns push subscription ID. More...
const string	endpoint () const
	Returns the endpoint URL. More...
const string	server_key () const
	Returns the server public key for signature verification. More...
const vector< Easy::alert_type >	alerts () const
	Returns a vector of Easy::alert_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...

Protected Member Functions
bool	s_to_b (const string &str) const
	Converts string to bool. More...
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 push subscriptions.

Since

0.14.0

Member Function Documentation

alerts()

const vector< Easy::alert_type > PushSubscription::alerts

(

)

const

Returns a vector of Easy::alert_type.

Since

0.100.0

{
    vector<Easy::alert_type> alerts;
    const Json::Value node = get("alerts");
    for (auto it = node.begin(); it != node.end(); ++it)
    {
        const string &str = it.name();
        Easy::notification_type type;
        if (str.compare("mention") == 0)
        {
            type = notification_type::Mention;
        }
        else if (str.compare("reblog") == 0)
        {
            type = notification_type::Reblog;
        }
        else if (str.compare("favourite") == 0)
        {
            type = notification_type::Favourite;
        }
        else if (str.compare("follow") == 0)
        {
            type = notification_type::Follow;
        }
        else
        {
            type = notification_type::Undefined;
        }

        alerts.push_back({ type, s_to_b(it->asString()) });
    }
    return alerts;
}

endpoint()

const string PushSubscription::endpoint

(

)

const

Returns the endpoint URL.

Since

0.14.0

{
    return get_string("endpoint");
}

Entity() [1/3]

Easy::Entity::Entity

Constructs an empty Entity object.

Since

before 0.11.0

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

Entity() [2/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() [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 PushSubscription::id

(

)

const

Returns push subscription ID.

Since

0.14.0

{
    return get_string("id");
}

s_to_b()

bool PushSubscription::s_to_b ( const string &  str ) const

protected

Converts string to bool.

Returns

true if str is equal to "true", false otherwise

{
    if (str.compare("true") == 0)
    {
        return true;
    }
    else
    {
        return false;
    }
}

server_key()

const string PushSubscription::server_key

(

)

const

Returns the server public key for signature verification.

Since

0.14.0

{
    return get_string("server_key");
}

valid()

bool PushSubscription::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",
            "endpoint",
            "server_key",
            "alerts"
        });
}

---

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

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