Child of Mastodon::API with abstract methods. More...

#include <easy.hpp>

Inheritance diagram for Mastodon::Easy:

Classes
class	Account
	Class to hold accounts. More...

class	Application
	Class to hold applications. More...

class	Attachment
	Class to hold attachments. More...

class	Card
	Class to hold cards. More...

class	Context
	Class to hold contexts. More...

class	Emoji
	Class to hold emojis. More...

class	Entity
	Base class for all entities. More...

class	Instance
	Class to hold instances. More...

class	Link
	Class to hold the `Link`-header. More...

class	List
	Class to hold lists. More...

class	Mention
	Class to hold mentions. More...

class	Notification
	Class to hold notifications. More...

class	PushSubscription
	Class to hold push subscriptions. More...

class	Relationship
	Class to hold relationships. More...

class	Report
	Class to hold reports. More...

class	Results
	Class to hold results. More...

class	Status
	Class to hold statuses. More...

class	Tag
	Class to hold tags. More...

Public Types
enum	event_type { Update, Notification, Delete, Undefined }
	Describes the event type. More...

enum	visibility_type { Direct, Private, Unlisted, Public, Undefined }
	Describes visibility of toots. More...

enum	attachment_type { Image, Video, Gifv, Unknown, Undefined }
	Describes the attachment type. More...

enum	card_type { Link, Photo, Video, Rich, Undefined }
	Describes the card type. More...

enum	notification_type { Mention, Reblog, Favourite, Follow, Undefined }
	Describes the notification type. More...

typedef std::pair< event_type, string >	stream_event
	Used for stream events. More...

typedef std::map< Easy::notification_type, bool >	alertmap
	Map of 'notification type' and 'push is requested or not'. More...

Public Types inherited from Mastodon::API
enum	v1 { accounts_id, accounts_verify_credentials, accounts_id_followers, accounts_id_following, accounts_id_statuses, accounts_relationships, accounts_search, blocks, domain_blocks, endorsements, favourites, follow_requests, instance, custom_emojis, lists, accounts_id_lists, lists_id_accounts, lists_id, mutes, notifications, notifications_id, reports, search, statuses_id, statuses_id_context, statuses_id_card, statuses_id_reblogged_by, statuses_id_favourited_by, timelines_home, timelines_public, timelines_tag_hashtag, timelines_list_list_id, accounts_update_credentials, accounts_id_follow, accounts_id_unfollow, accounts_id_block, accounts_id_unblock, accounts_id_mute, accounts_id_unmute, accounts_id_pin, accounts_id_unpin, apps, follow_requests_id_authorize, follow_requests_id_reject, follows, media, notifications_clear, notifications_dismiss, statuses, statuses_id_reblog, statuses_id_unreblog, statuses_id_favourite, statuses_id_unfavourite, statuses_id_pin, statuses_id_unpin, statuses_id_mute, statuses_id_unmute, media_id, streaming_user, streaming_public, streaming_public_local, streaming_hashtag, streaming_list, push_subscription, bookmarks, statuses_id_bookmark, statuses_id_unbookmark }
	A list of all v1 API calls. More...

enum	v2 { search }
	A list of all v2 API calls. More...

typedef std::map< string, std::vector< string > >	parametermap
	Used for passing parameters. More...

Public Member Functions
	Easy (const string &instance, const string &access_token)
	Constructs a new Easy object. More...

const Link	get_link () const
	Gets the links from the last answer. More...

const Status	send_post (const Status &status, uint_fast16_t &error)
	Sends a toot. More...

const Status	send_toot (const Status &status, uint_fast16_t &error)
	Alias for send_post() More...

const vector< Notification >	get_notifications (uint_fast16_t &error, const uint_fast16_t limit=20, const string since_id=0, const string max_id=0)
	Gets notifications. More...

Public Member Functions inherited from Mastodon::API
	API (const string &instance, const string &access_token)
	Constructs a new API object. More...

void	set_useragent (const string &useragent)
	Sets the useragent. Default is mastodon-cpp/version. More...

const string	get_useragent () const
	Gets the useragent. More...

const string	get_instance () const
	Returns the instance. More...

uint_fast16_t	register_app1 (const string &client_name, const string &redirect_uri, const string &scopes, const string &website, string &client_id, string &client_secret, string &url)
	Register application, step 1/2. More...

uint_fast16_t	register_app1 (const string &instance, const string &client_name, const string &redirect_uri, const string &scopes, const string &website, string &client_id, string &client_secret, string &url)

uint_fast16_t	register_app2 (const string &client_id, const string &client_secret, const string &redirect_uri, const string &code, string &access_token)
	Register application, step 2/2. More...

uint_fast16_t	register_app2 (const string &instance, const string &client_id, const string &client_secret, const string &redirect_uri, const string &code, string &access_token)

const string	get_header (const string &header) const
	Gets the header from the last answer. More...

bool	exceptions (const bool &value)
	Turn exceptions on or off. Defaults to off. More...

bool	exceptions () const
	Returns true if exceptions are turned on, false otherwise.

void	set_proxy (const string &proxy, const string &userpw="")
	Sets the proxy. More...

void	get_proxy (string &proxy, string &userpw) const
	For internal use. More...

uint_fast16_t	get (const Mastodon::API::v1 &call, string &answer)
	Make a GET request which doesn't require parameters. More...

uint_fast16_t	get (const Mastodon::API::v1 &call, const parametermap &parameters, string &answer)
	Make a GET request which requires parameters. More...

uint_fast16_t	get (const Mastodon::API::v2 &call, const parametermap &parameters, string &answer)
	Make a GET request which requires parameters. More...

uint_fast16_t	get (const string &call, string &answer)
	Make a custom GET request. More...

uint_fast16_t	get (const Mastodon::API::v1 &call, const string &argument, string &answer)

uint_fast16_t	get (const Mastodon::API::v1 &call, const string &argument, const parametermap &parameters, string &answer)

uint_fast16_t	get_stream (const Mastodon::API::v1 &call, const parametermap &parameters, string &answer, std::unique_ptr< Mastodon::API::http > &ptr)
	Make a streaming GET request. More...

uint_fast16_t	get_stream (const Mastodon::API::v1 &call, string &answer, std::unique_ptr< Mastodon::API::http > &ptr)
	Make a streaming GET request. More...

uint_fast16_t	get_stream (const string &call, string &answer, std::unique_ptr< Mastodon::API::http > &ptr)
	Make a streaming GET request. More...

uint_fast16_t	get_stream (const Mastodon::API::v1 &call, const string &argument, string &answer, std::unique_ptr< Mastodon::API::http > &ptr)

uint_fast16_t	patch (const Mastodon::API::v1 &call, const parametermap &parameters, string &answer)
	Make a PATCH request. More...

uint_fast16_t	post (const Mastodon::API::v1 &call, string &answer)
	Make a POST request which doesn't require parameters. More...

uint_fast16_t	post (const Mastodon::API::v1 &call, const parametermap &parameters, string &answer)
	Make a POST request which requires parameters. More...

uint_fast16_t	post (const string &call, const parametermap &parameters, string &answer)
	Make a custom POST request. More...

uint_fast16_t	post (const Mastodon::API::v1 &call, const string &argument, string &answer)

uint_fast16_t	post (const Mastodon::API::v1 &call, const string &argument, const parametermap &parameters, string &answer)

uint_fast16_t	put (const Mastodon::API::v1 &call, const parametermap &parameters, string &answer)
	Make a PUT request which requires a parameters. More...

uint_fast16_t	put (const string &call, const parametermap &parameters, string &answer)
	Make a custom PUT request. More...

uint_fast16_t	put (const Mastodon::API::v1 &call, const string &argument, const parametermap &parameters, string &answer)

uint_fast16_t	del (const Mastodon::API::v1 &call, const parametermap &parameters)
	Make a DELETE request which requires parameters. More...

uint_fast16_t	del (const string &call, const parametermap &parameters, string &answer)
	Make a custom DELETE request. More...

uint_fast16_t	del (const Mastodon::API::v1 &call, const string &argument)

uint_fast16_t	del (const Mastodon::API::v1 &call, const string &argument, const parametermap &parameters)

Static Public Member Functions
static const std::vector< string >	json_array_to_vector (const string &json)
	Turns a JSON array into a vector of strings. More...

static const std::vector< stream_event >	parse_stream (const std::string &streamdata)
	Split stream into a vector of events. More...

static const string	strtime_utc (const system_clock::time_point &timepoint, const string &format)
	Converts a time_point to a string. More...

static const string	strtime_local (const system_clock::time_point &timepoint, const string &format)
	See strtime_utc. More...

Static Public Member Functions inherited from Mastodon::API
static const string	urlencode (const string &str)
	Percent-encodes a string. This is done automatically, unless you make a custom request. More...

static const string	urldecode (const string &str)
	Decodes a percent-encoded string. More...

static const string	unescape_html (const string &html)
	Replaces HTML entities with UTF-8 characters. More...

Static Protected Member Functions
static const string	strtime (const system_clock::time_point &timepoint, const string &format, const bool &utc)

Detailed Description

Child of Mastodon::API with abstract methods.

Since: before 0.11.0

Examples:: example12_easy_laststatus.cpp, example13_easy_stream.cpp, example14_easy_treeview.cpp, and example16_account_fields.cpp.

Member Typedef Documentation

◆ alertmap

typedef std::map<Easy::notification_type, bool> Mastodon::Easy::alertmap

Map of 'notification type' and 'push is requested or not'.

Used in PushSubscription::alerts().

Since: 0.13.3

◆ stream_event

typedef std::pair<event_type, string> Mastodon::Easy::stream_event

Used for stream events.

Since: before 0.11.0

Member Enumeration Documentation

◆ attachment_type

enum Mastodon::Easy::attachment_type

strong

Describes the attachment type.

Since: before 0.11.0

     {
         Image,
         Video,
         Gifv,
         Unknown,
         Undefined
     };

◆ card_type

enum Mastodon::Easy::card_type

strong

Describes the card type.

Since: before 0.11.0

     {
         Link,
         Photo,
         Video,
         Rich,
         Undefined
     };

◆ event_type

enum Mastodon::Easy::event_type

strong

Describes the event type.

Since: before 0.11.0

     {
         Update,
         Notification,
         Delete,
         Undefined
     };

◆ notification_type

enum Mastodon::Easy::notification_type

strong

Describes the notification type.

Since: before 0.11.0

     {
         Mention,
         Reblog,
         Favourite,
         Follow,
         Undefined
     };

◆ visibility_type

enum Mastodon::Easy::visibility_type

strong

Describes visibility of toots.

Since: before 0.11.0

     {
         Direct,
         Private,
         Unlisted,
         Public,
         Undefined
     };

Constructor & Destructor Documentation

◆ Easy()

Easy::Easy	(	const string &	instance,
		const string &	access_token
	)

explicit

Constructs a new Easy object.

To register your application, leave access_token blank and call register_app1() and register_app2().

Parameters

instance	The hostname of your instance
access_token	The access token

Since: before 0.11.0

28 : API(instance, access_token)

29 {}

Mastodon::API::API

API(const string &instance, const string &access_token)

Constructs a new API object.

Definition: mastodon-cpp.cpp:30

Member Function Documentation

◆ get_link()

const Easy::Link Easy::get_link ( ) const

Gets the links from the last answer.

Since: before 0.11.0

 {
     return Link(get_header("Link"));
 }

◆ get_notifications()

const vector< Easy::Notification > Easy::get_notifications	(	uint_fast16_t &	error,
		const uint_fast16_t	limit = `20`,
		const string	since_id = `0`,
		const string	max_id = `0`
	)

Gets notifications.

Parameters

error	Error code
limit	Maximum number of notifications
since_id	Return notifications newer than ID
max_id	Return notifications older than ID

Returns: vector of Easy::Notification.

Since: 0.21.0

 {
     API::parametermap parameters;
     string answer;
     error = 0;
 
     parameters.insert({ "limit", { std::to_string(limit) } });
     if (!since_id.empty())
     {
         parameters.insert({ "since_id", { since_id } });
     }
     if (!max_id.empty())
     {
         parameters.insert({ "max_id", { max_id } });
     }
 
     error = API::get(Mastodon::API::v1::notifications, parameters, answer);
 
     if (error == 0)
     {
         const vector<string> &answer_v = json_array_to_vector(answer);
         vector<Notification> notifications;
         notifications.resize(answer_v.size());
 
         // Transform vector of strings to vector of Notification.
         std::transform(answer_v.begin(), answer_v.end(), notifications.begin(),
                        [](const string s)
                        { return Notification(s); });
 
         return notifications;
     }
     else
     {
         ttdebug << "ERROR: Could not get notifications.\n";
         return { Notification() };
     }
 }

◆ json_array_to_vector()

const std::vector< string > Easy::json_array_to_vector ( const string & json )

static

Turns a JSON array into a vector of strings.

Parameters

json	JSON string holding the array

Returns: vector of strings or an empty vector on error

Since: before 0.11.0

 {
     Json::Value json_array;
     std::stringstream ss(json);
     ss >> json_array;
 
     if (json_array.isArray())
     {
         std::vector<string> vec;
         for (const Json::Value &value : json_array)
         {
             vec.push_back(value.toStyledString());
         }
         return vec;
     }
 
     ttdebug << "ERROR: JSON string holds no array\n";
     ttdebug << "String was: " << json << '\n';
     return {};
 }

◆ parse_stream()

const std::vector< Easy::stream_event > Easy::parse_stream ( const std::string & streamdata )

static

Split stream into a vector of events.

Parameters

streamdata Data from get_stream()

Returns: vector of stream events

Since: before 0.11.0

 {
     string stream = streamdata;
     std::regex reevent("event: (update|notification|delete)\ndata: (.*)\n");
     std::smatch match;
     std::vector<stream_event> vec = {};
 
     while (std::regex_search(stream, match, reevent))
     {
         const string &event = match[1].str();
         const string &data = match[2].str();
         event_type type = event_type::Undefined;
 
         if (event.compare("update") == 0)
             type = event_type::Update;
         else if (event.compare("notification") == 0)
             type = event_type::Notification;
         else if (event.compare("delete") == 0)
             type = event_type::Delete;
 
         vec.push_back(stream_event(type, data));
         stream = match.suffix().str();
     }
 
     return vec;
 }

◆ send_post()

const Easy::Status Easy::send_post	(	const Status &	status,
		uint_fast16_t &	error
	)

Sends a toot.

Parameters

status	The status to send
error	Error code

Returns: The new Easy::Status

Since: 0.18.1

 {
     API::parametermap parameters;
     string answer;
     error = 0;
 
     if (!status.content().empty())
     {
         parameters.insert({ "status", { status.content() }});
     }
     else
     {
         ttdebug << "ERROR: Easy::Status::content can not be empty.\n";
         error = 11;
         return Status();
     }
 
     if (!status.in_reply_to_id().empty())
     {
         parameters.insert({ "in_reply_to_id",
                           { status.in_reply_to_id() }});
     }
     if (status.sensitive())
     {
         parameters.insert({ "sensitive", { "true" }});
     }
     if (!status.spoiler_text().empty())
     {
         parameters.insert({ "spoiler_text", { status.spoiler_text() }});
     }
     if (status.visibility() != visibility_type::Undefined)
     {
         string visibility;
         switch (status.visibility())
         {
             case visibility_type::Direct:
                 visibility = "direct";
                 break;
             case visibility_type::Private:
                 visibility = "private";
                 break;
             case visibility_type::Unlisted:
                 visibility = "unlisted";
                 break;
             case visibility_type::Public:
                 visibility = "public";
                 break;
             default:
                 break;
         };
         parameters.insert({ "visibility", { visibility }});
     }
     if (!status.language().empty())
     {
         parameters.insert({ "language", { status.language() }});
     }
     if (!status.media_attachments().empty())
     {
         std::vector<string> media_ids;
         for (const Attachment &att : status.media_attachments())
         {
             API::parametermap param_att;
             if (!att.file().empty())
             {
                 param_att.insert({ "file", { att.file() }});
             }
             else
             {
                 ttdebug << "ERROR: Easy::Attachment::file can not be empty.\n";
                 error = 11;
                 return Status();
             }
             if (!att.description().empty())
             {
                 param_att.insert({ "description", { att.description() }});
             }
             if (!att.focus().empty())
             {
                 param_att.insert({ "focus",
                                  { std::to_string(att.focus()[0]) + ',' +
                                    std::to_string(att.focus()[1]) }});
             }
 
             error = post(API::v1::media, param_att, answer);
             if (error == 0)
             {
                 Attachment attachment(answer);
                 media_ids.push_back(attachment.id());
             }
             else
             {
                 ttdebug << "ERROR: Could not upload file.\n";
                 return Status();
             }
         }
 
         parameters.insert({ "media_ids", media_ids });
     }
 
     error = post(API::v1::statuses, parameters, answer);
     if (error == 0)
     {
         return Status(answer);
     }
     else
     {
         return Status();
     }
 }

◆ send_toot()

const Easy::Status Easy::send_toot	(	const Status &	status,
		uint_fast16_t &	error
	)

Alias for send_post()

Since: 0.17.0

 {
     return send_post(status, error);
 }

◆ strtime_local()

const string Easy::strtime_local	(	const system_clock::time_point &	timepoint,
		const string &	format
	)

static

See strtime_utc.

Returns: The local time as string

Since: 0.11.0

 {
     return strtime(timepoint, format, false);
 }

◆ strtime_utc()

const string Easy::strtime_utc	(	const system_clock::time_point &	timepoint,
		const string &	format
	)

static

Converts a time_point to a string.

The return value can not exceed 1023 chars.

Parameters

timepoint	The timepoint
format	The format of the string, same as with `strftime`.

Example:

auto timepoint = status.created_at();

cout << Easy::strtime_utc(timepoint, "%F, %T") << '\n';

Returns: The UTC time as string

Since: 0.11.0

 {
     return strtime(timepoint, format, true);
 }

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

src/easy/easy.hpp
src/easy/easy.cpp
src/easy/simple_calls.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ alertmap

◆ stream_event

Member Enumeration Documentation

◆ attachment_type

◆ card_type

◆ event_type

◆ notification_type

◆ visibility_type

Constructor & Destructor Documentation

◆ Easy()

Member Function Documentation

◆ get_link()

◆ get_notifications()

◆ json_array_to_vector()

◆ parse_stream()

◆ send_post()

◆ send_toot()

◆ strtime_local()

◆ strtime_utc()