Mastodon::Easy Namespace Reference

Collection of things that make it easier to interface with server software that implements the Mastodon API. More...

Classes
class	Account
	Class to hold accounts. More...
struct	account_field_type
	Describes an account-field. More...
struct	alert_type
	Type of notification and 'push is requested or not'. More...
class	API
	Child of Mastodon::API with abstract methods. 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	Conversation
	Class to hold conversations. More...
class	Emoji
	Class to hold emojis. More...
class	Entity
	Base class for all entities. More...
class	Filter
	Class to hold filters. 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	Poll
	Class to hold polls. More...
struct	poll_options_type
	Poll options returned by Poll::options(). More...
class	PushSubscription
	Class to hold push subscriptions. More...
class	Relationship
	Class to hold relationships. More...
class	Results
	Class to hold results. More...
struct	return_entity
	Return types for calls that return a single Easy::Entity. More...
struct	return_entity_vector
	Return types for calls that return multiple Easy::Entitys. More...
struct	stats_type
	Statistics returned by Instance::stats(). More...
class	Status
	Class to hold statuses. More...
struct	stream_event_type
	Used for stream events. More...
class	Tag
	Class to hold tags. More...
struct	time_type
	Type for time. Converts to time_point and string. More...
class	Token
	Class to hold applications. More...
struct	urls_type
	URLs returned by Instance::urls(). More...

Typedefs
typedef struct Mastodon::Easy::stream_event_type	stream_event_type
	Used for stream events. More...
typedef stream_event_type	stream_event
typedef struct Mastodon::Easy::alert_type	alert_type
	Type of notification and 'push is requested or not'. More...
typedef time_type	time
typedef struct Mastodon::Easy::account_field_type	account_field_type
	Describes an account-field. More...
typedef struct Mastodon::Easy::urls_type	urls_type
	URLs returned by Instance::urls(). More...
typedef struct Mastodon::Easy::stats_type	stats_type
	Statistics returned by Instance::stats().
typedef struct Mastodon::Easy::poll_options_type	poll_options_type
	Poll options returned by Poll::options().

Enumerations
enum	event_type {   Update, Notification, Delete, Error,   Filters_changed, Undefined }
	Describes the event type returned in streams. More...
enum	visibility_type {   Direct, Private, Unlisted, Public,   Undefined }
	Describes visibility of posts. 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...
enum	context_type {   Home, Notifications, Public, Thread,   Undefined }
	Describes the context. More...

Functions
const vector< string >	json_array_to_vector (const string &json)
	Turns a JSON array into a vector of strings. More...
const vector< stream_event_type >	parse_stream (const std::string &streamdata)
	Split stream into a vector of events. More...
const Easy::time_type	string_to_time (const string &strtime)
	Convert ISO 8601 time string to Easy::time. More...
std::ostream &	operator<< (std::ostream &out, const time_type &t)

Detailed Description

Collection of things that make it easier to interface with server software that implements the Mastodon API.

Typedef Documentation

account_field_type

typedef struct Mastodon::Easy::account_field_type Mastodon::Easy::account_field_type

Describes an account-field.

Since

0.106.0

alert_type

typedef struct Mastodon::Easy::alert_type Mastodon::Easy::alert_type

Type of notification and 'push is requested or not'.

Since

0.100.0

stream_event_type

typedef struct Mastodon::Easy::stream_event_type Mastodon::Easy::stream_event_type

Used for stream events.

Since

0.100.0

urls_type

typedef struct Mastodon::Easy::urls_type Mastodon::Easy::urls_type

URLs returned by Instance::urls().

Since

0.106.0

Enumeration Type 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
    };

context_type

enum Mastodon::Easy::context_type

strong

Describes the context.

Since

0.104.0

    {
        Home,
        Notifications,
        Public,
        Thread,
        Undefined
    };

event_type

enum Mastodon::Easy::event_type

strong

Describes the event type returned in streams.

Since

before 0.11.0

    {
        Update,
        Notification,
        Delete,
        Error,
        Filters_changed,
        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 posts.

Since

before 0.11.0

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

Function Documentation

json_array_to_vector()

const std::vector< string > Mastodon::Easy::json_array_to_vector

(

const string &

json

)

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

Examples

example01_get_public_timeline.cpp.

{
    Json::Value json_array;
    std::stringstream ss(json);
    ss >> json_array;

    if (json_array.isArray())
    {
        // Transform array of Json::Value to vector of string.
        std::vector<string> vec(json_array.size());
        std::transform(json_array.begin(), json_array.end(), vec.begin(),
                       [](const Json::Value &j)
                           { return j.toStyledString(); });
        return vec;
    }

    ttdebug << "ERROR: JSON string holds no array\n";
    ttdebug << "String was: " << json << '\n';
    return {};
}

operator<<()

std::ostream& Mastodon::Easy::operator<<	(	std::ostream &	out,
		const time_type &	t
	)

Since

0.100.0

    {
        const string s = t;         // Converts using operator const string().
        out << s;
        return out;
    }

parse_stream()

const vector< Easy::stream_event_type > Mastodon::Easy::parse_stream

(

const std::string &

streamdata

)

Split stream into a vector of events.

Parameters

streamdata

Data from get_stream()

Returns

vector of Easy::stream_event

Since

before 0.11.0

Examples

example02_stream.cpp.

{
    string stream = streamdata;
    std::regex reevent("event: (update|notification|delete|filters_changed"
                       "|ERROR)\ndata: (.*)\n");
    std::smatch match;
    std::vector<stream_event_type> 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 == "update")
            type = event_type::Update;
        else if (event == "notification")
            type = event_type::Notification;
        else if (event == "delete")
            type = event_type::Delete;
        else if (event == "ERROR")
            type = event_type::Error;
        else if (event == "filters_changed")
            type = event_type::Filters_changed;

        vec.push_back({ type, data });
        stream = match.suffix().str();
    }

    return vec;
}

string_to_time()

const Easy::time_type Mastodon::Easy::string_to_time

(

const string &

strtime

)

Convert ISO 8601 time string to Easy::time.

Parameters

strtime

Time string as returned by Mastodon.

{
    std::stringstream sstime(strtime);
    struct std::tm tm = {};
    tm.tm_isdst = -1;       // Detect daylight saving time.
    sstime >> std::get_time(&tm, "%Y-%m-%dT%T");
    std::time_t time = timegm(&tm); // Assume time is UTC.
    return { system_clock::from_time_t(time) };
}