mastodonpp::API Class Reference

Holds API endpoints. More...

#include <api.hpp>

Public Types
enum	v1 { instance }
	An enumeration of all v1 API endpoints. More...
enum	v2 { search }
	An enumeration of all v2 API endpoints. More...
using	endpoint_type = variant< v1, v2 >
	Type for endpoints. Either API::v1 or API::v2. More...

Public Member Functions
	API (endpoint_type &endpoint)
	Constructs an API object. You should never need this. More...
string	to_string () const
	Convert endpoint_type to string. More...

Detailed Description

Holds API endpoints.

Since

0.1.0

Member Typedef Documentation

endpoint_type

using mastodonpp::API::endpoint_type = variant<v1,v2>

Type for endpoints. Either API::v1 or API::v2.

Since

0.1.0

Member Enumeration Documentation

v1

enum mastodonpp::API::v1

strong

An enumeration of all v1 API endpoints.

The original / are substituted with _.

Since

0.1.0

    {
        instance
    };

v2

enum mastodonpp::API::v2

strong

An enumeration of all v2 API endpoints.

The original / are substituted with _.

Since

0.1.0

    {
        search
    };

Constructor & Destructor Documentation

API()

mastodonpp::API::API ( endpoint_type &  endpoint )

explicit

Constructs an API object. You should never need this.

This constructor exists to hide away the class members, which are used internally.

Since

0.1.0

    : _endpoint{move(endpoint)}
{}

Member Function Documentation

to_string()

string mastodonpp::API::to_string

(

)

const

Convert endpoint_type to string.

Since

0.1.0

{
    static const map<endpoint_type,string_view> endpoint_map
        {
            {v1::instance, "/api/v1/instance"},
            {v2::search, "/api/v2/search"}
        };
    return endpoint_map.at(_endpoint).data();
}

---

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

• include/api.hpp
• src/api.cpp