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

#include <easy.hpp>

Inheritance diagram for Mastodon::Easy::API:

Public Member Functions
	API (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 return_entity< Easy::Status >	send_post (const Status &status)
	Sends a post. More...

const return_entity< Easy::Status >	send_toot (const Status &status)
	Alias for send_post() More...

const return_entity_vector< Easy::Notification >	get_notifications (const uint16_t limit=20, const string since_id="", const string max_id="")
	Gets notifications. More...

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

virtual	~API ()
	Destroys the 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...

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

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

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

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

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

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

const return_call	get (const string &call)
	Make a custom GET request. More...

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

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

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

return_call	patch (const Mastodon::API::v1 &call, const parameters &parameters)
	Make a PATCH request. More...

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

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

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

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

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

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

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

Additional Inherited Members
Public Types inherited from Mastodon::API
enum	v1 { accounts_id, accounts_verify_credentials, accounts_update_credentials, accounts_id_followers, accounts_id_following, accounts_id_statuses, accounts_id_follow, accounts_id_unfollow, accounts_relationships, accounts_search, apps, blocks, accounts_id_block, accounts_id_unblock, custom_emojis, domain_blocks, endorsements, accounts_id_pin, accounts_id_unpin, favourites, statuses_id_favourite, statuses_id_unfavourite, follow_requests, follow_requests_id_authorize, follow_requests_id_reject, instance, lists, accounts_id_lists, lists_id, lists_id_accounts, media, media_id, mutes, accounts_id_mute, accounts_id_unmute, statuses_id_mute, statuses_id_unmute, notifications, notifications_id, notifications_clear, notifications_dismiss, push_subscription, reports, search, statuses, statuses_id, statuses_id_context, statuses_id_card, statuses_id_reblogged_by, statuses_id_favourited_by, statuses_id_reblog, statuses_id_unreblog, statuses_id_pin, statuses_id_unpin, timelines_home, timelines_public, timelines_tag_hashtag, timelines_list_list_id, streaming_user, streaming_public, streaming_public_local, streaming_hashtag, streaming_list, 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...

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

Detailed Description

Child of Mastodon::API with abstract methods.

Provides convenient functions to deal with the responses you get.

Examples:: example01_get_public_timeline.cpp, and example02_stream.cpp.

Constructor & Destructor Documentation

◆ API()

Easy::API::API	(	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: 0.100.0

28 : Mastodon::API(instance, access_token)

29 {}

Mastodon::API

Interface to the Mastodon API.

Definition: mastodon-cpp.hpp:76

Member Function Documentation

◆ get_link()

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

Gets the links from the last answer.

Since: 0.100.0

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

◆ get_notifications()

const return_entity_vector< Notification > API::get_notifications	(	const uint16_t	limit = `20`,
		const string	since_id = `""`,
		const string	max_id = `""`
	)

Gets notifications.

Parameters

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

 {
     parameters params;
 
     params.push_back({ "limit", { std::to_string(limit) } });
     if (!since_id.empty())
     {
         params.push_back({ "since_id", { since_id } });
     }
     if (!max_id.empty())
     {
         params.push_back({ "max_id", { max_id } });
     }
 
     return_call ret = API::get(API::v1::notifications, params);
 
     if (ret.error_code == 0)
     {
         const vector<string> &answer_v = json_array_to_vector(ret.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 { ret.error_code, ret.error_message, notifications };
     }
     else
     {
         ttdebug << "ERROR: Could not get notifications.\n";
         return { ret.error_code, ret.error_message, {} };
     }
 }

◆ send_post()

const return_entity< Status > API::send_post ( const Status & status )

Sends a post.

Parameters

status The status to send

Returns: The new Easy::Status

Since: 0.100.0

 {
     parameters params;
 
     if (!status.content().empty())
     {
         params.push_back({ "status", { status.content() }});
     }
     else
     {
         ttdebug << "ERROR: Easy::Status::content can not be empty.\n";
         return {22, "Easy::Status::content can not be empty", Status()};
     }
 
     if (!status.in_reply_to_id().empty())
     {
         params.push_back({ "in_reply_to_id",
                            { status.in_reply_to_id() }});
     }
     if (status.sensitive())
     {
         params.push_back({ "sensitive", { "true" }});
     }
     if (!status.spoiler_text().empty())
     {
         params.push_back({ "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;
         };
         params.push_back({ "visibility", { visibility }});
     }
     if (!status.language().empty())
     {
         params.push_back({ "language", { status.language() }});
     }
     if (!status.media_attachments().empty())
     {
         std::vector<string> media_ids;
         for (const Attachment &att : status.media_attachments())
         {
             parameters param_att;
             if (!att.file().empty())
             {
                 param_att.push_back({ "file", { att.file() }});
             }
             else
             {
                 ttdebug << "ERROR: Easy::Attachment::file can not be empty.\n";
                 return { 22, "Easy::Attachment::file can not be empty",
                     Status() };
             }
             if (!att.description().empty())
             {
                 param_att.push_back({ "description", { att.description() }});
             }
             if (!att.focus().empty())
             {
                 param_att.push_back({ "focus",
                                       { std::to_string(att.focus()[0]) + ',' +
                                         std::to_string(att.focus()[1]) }});
             }
 
             return_call ret = post(API::v1::media, param_att);
             if (ret.error_code == 0)
             {
                 Attachment attachment(ret.answer);
                 media_ids.push_back(attachment.id());
             }
             else
             {
                 ttdebug << "ERROR: Could not upload file.\n";
                 return { ret.error_code, ret.error_message,
                     Status(ret.answer) };
             }
         }
 
         params.push_back({ "media_ids", media_ids });
     }
 
     return_call ret = post(API::v1::statuses, params);
     return { ret.error_code, ret.error_message, Status(ret.answer) };
 }

◆ send_toot()

const return_entity< Status > API::send_toot ( const Status & status )

Alias for send_post()

Since: 0.100.0

 {
     return send_post(status);
 }

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ API()

Member Function Documentation

◆ get_link()

◆ get_notifications()

◆ send_post()

◆ send_toot()