mastodon-cpp  0.104.0
Public Member Functions | Protected Member Functions | List of all members
Mastodon::Easy::PushSubscription Class Reference

Class to hold push subscriptions. More...

#include <pushsubscription.hpp>

Inheritance diagram for Mastodon::Easy::PushSubscription:
Mastodon::Easy::Entity

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 Easy::alerts 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 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 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 Easy::alerts PushSubscription::alerts ( ) const

Returns a vector of Easy::alert_type.

Since
0.100.0
50 {
52  const Json::Value node = get("alerts");
53  for (auto it = node.begin(); it != node.end(); ++it)
54  {
55  const string &str = it.name();
57  if (str.compare("mention") == 0)
58  {
59  type = notification_type::Mention;
60  }
61  else if (str.compare("reblog") == 0)
62  {
63  type = notification_type::Reblog;
64  }
65  else if (str.compare("favourite") == 0)
66  {
67  type = notification_type::Favourite;
68  }
69  else if (str.compare("follow") == 0)
70  {
71  type = notification_type::Follow;
72  }
73  else
74  {
75  type = notification_type::Undefined;
76  }
77 
78  alerts.push_back({ type, s_to_b(it->asString()) });
79  }
80  return alerts;
81 }
vector< alert_type > alerts
Vector of Easy::alert_type.
Definition: types_easy.hpp:148
bool s_to_b(const string &str) const
Converts string to bool.
Definition: pushsubscription.cpp:83
notification_type
Describes the notification type.
Definition: types_easy.hpp:96
const Easy::alerts alerts() const
Returns a vector of Easy::alert_type.
Definition: pushsubscription.cpp:49

◆ endpoint()

const string PushSubscription::endpoint ( ) const

Returns the endpoint URL.

Since
0.14.0
40 {
41  return get_string("endpoint");
42 }
const string get_string(const string &key) const
Returns the value of key as std::string.
Definition: entity.cpp:173

◆ Entity() [1/3]

Easy::Entity::Entity

Constructs an empty Entity object.

Since
before 0.11.0
43 : _tree(Json::nullValue)
44 , _was_set(false)
45 {}

◆ Entity() [2/3]

Easy::Entity::Entity
explicit

Constructs an Entity object from a JSON object.

Parameters
objectJSON object
Since
0.100.0
38 : _tree(object)
39 ,_was_set(false)
40 {}

◆ Entity() [3/3]

Easy::Entity::Entity
explicit

Constructs an Entity object from a JSON string.

Parameters
jsonJSON string
Since
before 0.11.0
31 : _tree(Json::nullValue)
32 ,_was_set(false)
33 {
34  from_string(json);
35 }
void from_string(const string &json)
Replaces the Entity with a new one from a JSON string.
Definition: entity.cpp:55

◆ id()

const string PushSubscription::id ( ) const

Returns push subscription ID.

Since
0.14.0
23 {
24  return get_string("id");
25 }
const string get_string(const string &key) const
Returns the value of key as std::string.
Definition: entity.cpp:173

◆ 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
84 {
85  if (str.compare("true") == 0)
86  {
87  return true;
88  }
89  else
90  {
91  return false;
92  }
93 }

◆ server_key()

const string PushSubscription::server_key ( ) const

Returns the server public key for signature verification.

Since
0.14.0
45 {
46  return get_string("server_key");
47 }
const string get_string(const string &key) const
Returns the value of key as std::string.
Definition: entity.cpp:173

◆ 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.

28 {
29  const std::vector<string> attributes =
30  {{
31  "id",
32  "endpoint",
33  "server_key"
34  }};
35 
36  return Entity::check_valid(attributes);
37 }
bool check_valid(const std::vector< string > &attributes) const
Checks if an Entity is valid.
Definition: entity.cpp:101

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