803 lines
50 KiB
HTML
803 lines
50 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.9.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>mastodonpp: mastodonpp::API Class Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">mastodonpp
|
|
 <span id="projectnumber">0.5.7</span>
|
|
</div>
|
|
<div id="projectbrief">C++ wrapper for the Mastodon and Pleroma APIs.</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.1 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="namespacemastodonpp.html">mastodonpp</a></li><li class="navelem"><a class="el" href="classmastodonpp_1_1API.html">API</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classmastodonpp_1_1API-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">mastodonpp::API Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Holds API endpoints.
|
|
<a href="classmastodonpp_1_1API.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="api_8hpp_source.html">mastodonpp/api.hpp</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:aee8f590426914a36f948dafa78e330f2"><td class="memItemLeft" align="right" valign="top">enum class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1API.html#aee8f590426914a36f948dafa78e330f2">v1</a> { <br />
|
|
  <b>apps</b>
|
|
, <b>apps_verify_credentials</b>
|
|
, <b>accounts</b>
|
|
, <b>accounts_verify_credentials</b>
|
|
, <br />
|
|
  <b>accounts_update_credentials</b>
|
|
, <b>accounts_id</b>
|
|
, <b>accounts_id_statuses</b>
|
|
, <b>accounts_id_followers</b>
|
|
, <br />
|
|
  <b>accounts_id_following</b>
|
|
, <b>accounts_id_lists</b>
|
|
, <b>accounts_id_identity_proofs</b>
|
|
, <b>accounts_id_follow</b>
|
|
, <br />
|
|
  <b>accounts_id_unfollow</b>
|
|
, <b>accounts_id_block</b>
|
|
, <b>accounts_id_unblock</b>
|
|
, <b>accounts_id_mute</b>
|
|
, <br />
|
|
  <b>accounts_id_unmute</b>
|
|
, <b>accounts_id_pin</b>
|
|
, <b>accounts_id_unpin</b>
|
|
, <b>accounts_relationships</b>
|
|
, <br />
|
|
  <b>accounts_search</b>
|
|
, <b>bookmarks</b>
|
|
, <b>favourites</b>
|
|
, <b>mutes</b>
|
|
, <br />
|
|
  <b>blocks</b>
|
|
, <b>domain_blocks</b>
|
|
, <b>filters</b>
|
|
, <b>filters_id</b>
|
|
, <br />
|
|
  <b>reports</b>
|
|
, <b>follow_requests</b>
|
|
, <b>follow_requests_id_authorize</b>
|
|
, <b>follow_requests_id_reject</b>
|
|
, <br />
|
|
  <b>endorsements</b>
|
|
, <b>featured_tags</b>
|
|
, <b>featured_tags_id</b>
|
|
, <b>featured_tags_suggestions</b>
|
|
, <br />
|
|
  <b>preferences</b>
|
|
, <b>suggestions</b>
|
|
, <b>suggestions_account_id</b>
|
|
, <b>statuses</b>
|
|
, <br />
|
|
  <b>statuses_id</b>
|
|
, <b>statuses_id_context</b>
|
|
, <b>statuses_id_reblogged_by</b>
|
|
, <b>statuses_id_favourited_by</b>
|
|
, <br />
|
|
  <b>statuses_id_favourite</b>
|
|
, <b>statuses_id_unfavourite</b>
|
|
, <b>statuses_id_reblog</b>
|
|
, <b>statuses_id_unreblog</b>
|
|
, <br />
|
|
  <b>statuses_id_bookmark</b>
|
|
, <b>statuses_id_unbookmark</b>
|
|
, <b>statuses_id_mute</b>
|
|
, <b>statuses_id_unmute</b>
|
|
, <br />
|
|
  <b>statuses_id_pin</b>
|
|
, <b>statuses_id_unpin</b>
|
|
, <b>media</b>
|
|
, <b>media_id</b>
|
|
, <br />
|
|
  <b>polls_id</b>
|
|
, <b>polls_id_votes</b>
|
|
, <b>scheduled_statuses</b>
|
|
, <b>scheduled_statuses_id</b>
|
|
, <br />
|
|
  <b>timelines_public</b>
|
|
, <b>timelines_tag_hashtag</b>
|
|
, <b>timelines_home</b>
|
|
, <b>timelines_list_list_id</b>
|
|
, <br />
|
|
  <b>conversations</b>
|
|
, <b>conversations_id</b>
|
|
, <b>conversations_id_read</b>
|
|
, <b>lists</b>
|
|
, <br />
|
|
  <b>lists_id</b>
|
|
, <b>lists_id_accounts</b>
|
|
, <b>markers</b>
|
|
, <b>streaming_health</b>
|
|
, <br />
|
|
  <b>streaming_user</b>
|
|
, <b>streaming_public</b>
|
|
, <b>streaming_public_local</b>
|
|
, <b>streaming_hashtag</b>
|
|
, <br />
|
|
  <b>streaming_hashtag_local</b>
|
|
, <b>streaming_list</b>
|
|
, <b>streaming_direct</b>
|
|
, <b>notifications</b>
|
|
, <br />
|
|
  <b>notifications_id</b>
|
|
, <b>notifications_clear</b>
|
|
, <b>notifications_id_dismiss</b>
|
|
, <b>push_subscription</b>
|
|
, <br />
|
|
  <b>instance</b>
|
|
, <b>instance_peers</b>
|
|
, <b>instance_activity</b>
|
|
, <b>trends</b>
|
|
, <br />
|
|
  <b>directory</b>
|
|
, <b>custom_emojis</b>
|
|
, <b>admin_accounts</b>
|
|
, <b>admin_accounts_id</b>
|
|
, <br />
|
|
  <b>admin_accounts_account_id_action</b>
|
|
, <b>admin_accounts_id_approve</b>
|
|
, <b>admin_accounts_id_reject</b>
|
|
, <b>admin_accounts_id_enable</b>
|
|
, <br />
|
|
  <b>admin_accounts_id_unsilence</b>
|
|
, <b>admin_accounts_id_unsuspend</b>
|
|
, <b>admin_reports</b>
|
|
, <b>admin_reports_id</b>
|
|
, <br />
|
|
  <b>admin_reports_id_assign_to_self</b>
|
|
, <b>admin_reports_id_unassign</b>
|
|
, <b>admin_reports_id_resolve</b>
|
|
, <b>admin_reports_id_reopen</b>
|
|
, <br />
|
|
  <b>pleroma_notifications_read</b>
|
|
, <b>pleroma_accounts_id_subscribe</b>
|
|
, <b>pleroma_accounts_id_unsubscribe</b>
|
|
, <b>pleroma_accounts_id_favourites</b>
|
|
, <br />
|
|
  <b>pleroma_accounts_update_avatar</b>
|
|
, <b>pleroma_accounts_update_banner</b>
|
|
, <b>pleroma_accounts_update_background</b>
|
|
, <b>pleroma_accounts_confirmation_resend</b>
|
|
, <br />
|
|
  <b>pleroma_mascot</b>
|
|
, <b>pleroma_conversations_id_statuses</b>
|
|
, <b>pleroma_conversations_id</b>
|
|
, <b>pleroma_conversations_id_read</b>
|
|
, <br />
|
|
  <b>pleroma_accounts_id_scrobbles</b>
|
|
, <b>pleroma_scrobble</b>
|
|
, <b>pleroma_statuses_id_reactions_emoji</b>
|
|
, <b>pleroma_statuses_id_reactions</b>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:aee8f590426914a36f948dafa78e330f2"><td class="mdescLeft"> </td><td class="mdescRight">An enumeration of all v1 API endpoints. <a href="classmastodonpp_1_1API.html#aee8f590426914a36f948dafa78e330f2">More...</a><br /></td></tr>
|
|
<tr class="separator:aee8f590426914a36f948dafa78e330f2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a67ba7c7a8d94ec7905e45466255648ba"><td class="memItemLeft" align="right" valign="top">enum class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1API.html#a67ba7c7a8d94ec7905e45466255648ba">v2</a> { <b>search</b>
|
|
}</td></tr>
|
|
<tr class="memdesc:a67ba7c7a8d94ec7905e45466255648ba"><td class="mdescLeft"> </td><td class="mdescRight">An enumeration of all v2 API endpoints. <a href="classmastodonpp_1_1API.html#a67ba7c7a8d94ec7905e45466255648ba">More...</a><br /></td></tr>
|
|
<tr class="separator:a67ba7c7a8d94ec7905e45466255648ba"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a36332bb17e8603f0ba40b63b0b604bcc"><td class="memItemLeft" align="right" valign="top">enum class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1API.html#a36332bb17e8603f0ba40b63b0b604bcc">oauth</a> { <b>authorize</b>
|
|
, <b>token</b>
|
|
, <b>revoke</b>
|
|
}</td></tr>
|
|
<tr class="memdesc:a36332bb17e8603f0ba40b63b0b604bcc"><td class="mdescLeft"> </td><td class="mdescRight">An enumeration of all oauth API endpoints. <a href="classmastodonpp_1_1API.html#a36332bb17e8603f0ba40b63b0b604bcc">More...</a><br /></td></tr>
|
|
<tr class="separator:a36332bb17e8603f0ba40b63b0b604bcc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abd51b671f4bd4f6021d8044e281d4c76"><td class="memItemLeft" align="right" valign="top">enum class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1API.html#abd51b671f4bd4f6021d8044e281d4c76">other</a> { <b>proofs</b>
|
|
, <b>oembed</b>
|
|
}</td></tr>
|
|
<tr class="memdesc:abd51b671f4bd4f6021d8044e281d4c76"><td class="mdescLeft"> </td><td class="mdescRight">An enumeration of all other API endpoints. <a href="classmastodonpp_1_1API.html#abd51b671f4bd4f6021d8044e281d4c76">More...</a><br /></td></tr>
|
|
<tr class="separator:abd51b671f4bd4f6021d8044e281d4c76"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a146a96ee58a8829042f406b9d42cf37e"><td class="memItemLeft" align="right" valign="top">enum class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1API.html#a146a96ee58a8829042f406b9d42cf37e">pleroma</a> { <br />
|
|
  <b>admin_users</b>
|
|
, <b>admin_users_follow</b>
|
|
, <b>admin_users_unfollow</b>
|
|
, <b>admin_users_nickname_toggle_activation</b>
|
|
, <br />
|
|
  <b>admin_users_tag</b>
|
|
, <b>admin_users_nickname_permission_group</b>
|
|
, <b>admin_users_nickname_permission_group_permission_group</b>
|
|
, <b>admin_users_permission_group_permission_group</b>
|
|
, <br />
|
|
  <b>admin_users_activate</b>
|
|
, <b>admin_users_deactivate</b>
|
|
, <b>admin_users_nickname_or_id</b>
|
|
, <b>admin_users_nickname_or_id_statuses</b>
|
|
, <br />
|
|
  <b>admin_instances_instance_statuses</b>
|
|
, <b>admin_statuses</b>
|
|
, <b>admin_relay</b>
|
|
, <b>admin_users_invite_token</b>
|
|
, <br />
|
|
  <b>admin_users_invites</b>
|
|
, <b>admin_users_revoke_invite</b>
|
|
, <b>admin_users_email_invite</b>
|
|
, <b>admin_users_nickname_password_reset</b>
|
|
, <br />
|
|
  <b>admin_users_nickname_update_credentials</b>
|
|
, <b>admin_users_force_password_reset</b>
|
|
, <b>admin_reports</b>
|
|
, <b>admin_grouped_reports</b>
|
|
, <br />
|
|
  <b>admin_reports_id</b>
|
|
, <b>admin_reports_id_notes</b>
|
|
, <b>admin_reports_report_id_notes_id</b>
|
|
, <b>admin_statuses_id</b>
|
|
, <br />
|
|
  <b>admin_restart</b>
|
|
, <b>admin_config</b>
|
|
, <b>admin_config_descriptions</b>
|
|
, <b>admin_moderation_log</b>
|
|
, <br />
|
|
  <b>admin_reload_emoji</b>
|
|
, <b>admin_users_confirm_email</b>
|
|
, <b>admin_users_resend_confirm_email</b>
|
|
, <b>admin_stats</b>
|
|
, <br />
|
|
  <b>admin_users_nickname</b>
|
|
, <b>admin_users_nickname_activation_status</b>
|
|
, <b>admin_reports_id_respond</b>
|
|
, <b>admin_config_migrate_to_db</b>
|
|
, <br />
|
|
  <b>admin_config_migrate_from_db</b>
|
|
, <b>emoji</b>
|
|
, <b>follow_import</b>
|
|
, <b>captcha</b>
|
|
, <br />
|
|
  <b>delete_account</b>
|
|
, <b>disable_account</b>
|
|
, <b>notification_settings</b>
|
|
, <b>healthcheck</b>
|
|
, <br />
|
|
  <b>change_email</b>
|
|
, <b>emoji_packs</b>
|
|
, <b>emoji_packs_name</b>
|
|
, <b>emoji_packs_name_update_file</b>
|
|
, <br />
|
|
  <b>emoji_packs_name_update_metadata</b>
|
|
, <b>emoji_packs_download_from</b>
|
|
, <b>emoji_packs_list_from</b>
|
|
, <b>emoji_packs_name_download_shared</b>
|
|
, <br />
|
|
  <b>account_register</b>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:a146a96ee58a8829042f406b9d42cf37e"><td class="mdescLeft"> </td><td class="mdescRight">An enumeration of all pleroma API endpoints. <a href="classmastodonpp_1_1API.html#a146a96ee58a8829042f406b9d42cf37e">More...</a><br /></td></tr>
|
|
<tr class="separator:a146a96ee58a8829042f406b9d42cf37e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7f74ce81c1f0cbc0ed6ad66b2bd24318"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1API.html#a7f74ce81c1f0cbc0ed6ad66b2bd24318">endpoint_type</a> = variant< <a class="el" href="classmastodonpp_1_1API.html#aee8f590426914a36f948dafa78e330f2">v1</a>, <a class="el" href="classmastodonpp_1_1API.html#a67ba7c7a8d94ec7905e45466255648ba">v2</a>, <a class="el" href="classmastodonpp_1_1API.html#a36332bb17e8603f0ba40b63b0b604bcc">oauth</a>, <a class="el" href="classmastodonpp_1_1API.html#abd51b671f4bd4f6021d8044e281d4c76">other</a>, <a class="el" href="classmastodonpp_1_1API.html#a146a96ee58a8829042f406b9d42cf37e">pleroma</a> ></td></tr>
|
|
<tr class="memdesc:a7f74ce81c1f0cbc0ed6ad66b2bd24318"><td class="mdescLeft"> </td><td class="mdescRight">Type for endpoints. Can be <a class="el" href="classmastodonpp_1_1API.html#aee8f590426914a36f948dafa78e330f2" title="An enumeration of all v1 API endpoints.">API::v1</a>, <a class="el" href="classmastodonpp_1_1API.html#a67ba7c7a8d94ec7905e45466255648ba" title="An enumeration of all v2 API endpoints.">API::v2</a>, <a class="el" href="classmastodonpp_1_1API.html#a36332bb17e8603f0ba40b63b0b604bcc" title="An enumeration of all oauth API endpoints.">API::oauth</a>, <a class="el" href="classmastodonpp_1_1API.html#abd51b671f4bd4f6021d8044e281d4c76" title="An enumeration of all other API endpoints.">API::other</a> or <a class="el" href="classmastodonpp_1_1API.html#a146a96ee58a8829042f406b9d42cf37e" title="An enumeration of all pleroma API endpoints.">API::pleroma</a>. <a href="classmastodonpp_1_1API.html#a7f74ce81c1f0cbc0ed6ad66b2bd24318">More...</a><br /></td></tr>
|
|
<tr class="separator:a7f74ce81c1f0cbc0ed6ad66b2bd24318"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:af9fc7a7d152a851122f8acc3224d4047"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1API.html#af9fc7a7d152a851122f8acc3224d4047">API</a> (const <a class="el" href="classmastodonpp_1_1API.html#a7f74ce81c1f0cbc0ed6ad66b2bd24318">endpoint_type</a> &endpoint)</td></tr>
|
|
<tr class="memdesc:af9fc7a7d152a851122f8acc3224d4047"><td class="mdescLeft"> </td><td class="mdescRight">Constructs an <a class="el" href="classmastodonpp_1_1API.html" title="Holds API endpoints.">API</a> object. You should never need this. <a href="classmastodonpp_1_1API.html#af9fc7a7d152a851122f8acc3224d4047">More...</a><br /></td></tr>
|
|
<tr class="separator:af9fc7a7d152a851122f8acc3224d4047"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa51c43b5c7cc2afd32520d08d51bcfc3"><td class="memItemLeft" align="right" valign="top">string_view </td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1API.html#aa51c43b5c7cc2afd32520d08d51bcfc3">to_string_view</a> () const</td></tr>
|
|
<tr class="memdesc:aa51c43b5c7cc2afd32520d08d51bcfc3"><td class="mdescLeft"> </td><td class="mdescRight">Convert <a class="el" href="classmastodonpp_1_1API.html#a7f74ce81c1f0cbc0ed6ad66b2bd24318" title="Type for endpoints. Can be API::v1, API::v2, API::oauth, API::other or API::pleroma.">endpoint_type</a> to <code>std::string_view</code>. <a href="classmastodonpp_1_1API.html#aa51c43b5c7cc2afd32520d08d51bcfc3">More...</a><br /></td></tr>
|
|
<tr class="separator:aa51c43b5c7cc2afd32520d08d51bcfc3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Holds API endpoints. </p>
|
|
<p>Supported API endpoints: Mastodon 3.0.1, Pleroma 2.0.2.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>0.1.0 </dd></dl>
|
|
</div><h2 class="groupheader">Member Typedef Documentation</h2>
|
|
<a id="a7f74ce81c1f0cbc0ed6ad66b2bd24318"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7f74ce81c1f0cbc0ed6ad66b2bd24318">◆ </a></span>endpoint_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classmastodonpp_1_1API.html#a7f74ce81c1f0cbc0ed6ad66b2bd24318">mastodonpp::API::endpoint_type</a> = variant<<a class="el" href="classmastodonpp_1_1API.html#aee8f590426914a36f948dafa78e330f2">v1</a>, <a class="el" href="classmastodonpp_1_1API.html#a67ba7c7a8d94ec7905e45466255648ba">v2</a>, <a class="el" href="classmastodonpp_1_1API.html#a36332bb17e8603f0ba40b63b0b604bcc">oauth</a>, <a class="el" href="classmastodonpp_1_1API.html#abd51b671f4bd4f6021d8044e281d4c76">other</a>, <a class="el" href="classmastodonpp_1_1API.html#a146a96ee58a8829042f406b9d42cf37e">pleroma</a>></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Type for endpoints. Can be <a class="el" href="classmastodonpp_1_1API.html#aee8f590426914a36f948dafa78e330f2" title="An enumeration of all v1 API endpoints.">API::v1</a>, <a class="el" href="classmastodonpp_1_1API.html#a67ba7c7a8d94ec7905e45466255648ba" title="An enumeration of all v2 API endpoints.">API::v2</a>, <a class="el" href="classmastodonpp_1_1API.html#a36332bb17e8603f0ba40b63b0b604bcc" title="An enumeration of all oauth API endpoints.">API::oauth</a>, <a class="el" href="classmastodonpp_1_1API.html#abd51b671f4bd4f6021d8044e281d4c76" title="An enumeration of all other API endpoints.">API::other</a> or <a class="el" href="classmastodonpp_1_1API.html#a146a96ee58a8829042f406b9d42cf37e" title="An enumeration of all pleroma API endpoints.">API::pleroma</a>. </p>
|
|
<dl class="section since"><dt>Since</dt><dd>0.1.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Enumeration Documentation</h2>
|
|
<a id="a36332bb17e8603f0ba40b63b0b604bcc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a36332bb17e8603f0ba40b63b0b604bcc">◆ </a></span>oauth</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="classmastodonpp_1_1API.html#a36332bb17e8603f0ba40b63b0b604bcc">mastodonpp::API::oauth</a></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>An enumeration of all oauth API endpoints. </p>
|
|
<p>The original <code>/</code> are substituted with <code>_</code>. <code>:</code> are omitted.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>0.1.0 </dd></dl>
|
|
<div class="fragment"><div class="line"><a name="l00224"></a><span class="lineno"> 224</span>  {</div>
|
|
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span>  authorize,</div>
|
|
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span>  token,</div>
|
|
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span>  revoke</div>
|
|
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span>  };</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="abd51b671f4bd4f6021d8044e281d4c76"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abd51b671f4bd4f6021d8044e281d4c76">◆ </a></span>other</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="classmastodonpp_1_1API.html#abd51b671f4bd4f6021d8044e281d4c76">mastodonpp::API::other</a></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>An enumeration of all other API endpoints. </p>
|
|
<p>These endpoints are directly under <code>/api/</code>.</p>
|
|
<p>The original <code>/</code> are substituted with <code>_</code>. <code>:</code> are omitted.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>0.1.0 </dd></dl>
|
|
<div class="fragment"><div class="line"><a name="l00240"></a><span class="lineno"> 240</span>  {</div>
|
|
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span>  proofs,</div>
|
|
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span>  oembed</div>
|
|
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span>  };</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a146a96ee58a8829042f406b9d42cf37e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a146a96ee58a8829042f406b9d42cf37e">◆ </a></span>pleroma</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="classmastodonpp_1_1API.html#a146a96ee58a8829042f406b9d42cf37e">mastodonpp::API::pleroma</a></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>An enumeration of all pleroma API endpoints. </p>
|
|
<p>The original <code>/</code> are substituted with <code>_</code>. <code>:</code> are omitted.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>0.1.0 </dd></dl>
|
|
<div class="fragment"><div class="line"><a name="l00253"></a><span class="lineno"> 253</span>  {</div>
|
|
<div class="line"><a name="l00254"></a><span class="lineno"> 254</span>  admin_users,</div>
|
|
<div class="line"><a name="l00255"></a><span class="lineno"> 255</span>  admin_users_follow,</div>
|
|
<div class="line"><a name="l00256"></a><span class="lineno"> 256</span>  admin_users_unfollow,</div>
|
|
<div class="line"><a name="l00257"></a><span class="lineno"> 257</span>  admin_users_nickname_toggle_activation,</div>
|
|
<div class="line"><a name="l00258"></a><span class="lineno"> 258</span>  admin_users_tag,</div>
|
|
<div class="line"><a name="l00259"></a><span class="lineno"> 259</span>  admin_users_nickname_permission_group,</div>
|
|
<div class="line"><a name="l00260"></a><span class="lineno"> 260</span>  admin_users_nickname_permission_group_permission_group,</div>
|
|
<div class="line"><a name="l00261"></a><span class="lineno"> 261</span>  admin_users_permission_group_permission_group,</div>
|
|
<div class="line"><a name="l00262"></a><span class="lineno"> 262</span>  admin_users_activate,</div>
|
|
<div class="line"><a name="l00263"></a><span class="lineno"> 263</span>  admin_users_deactivate,</div>
|
|
<div class="line"><a name="l00264"></a><span class="lineno"> 264</span>  admin_users_nickname_or_id,</div>
|
|
<div class="line"><a name="l00265"></a><span class="lineno"> 265</span>  admin_users_nickname_or_id_statuses,</div>
|
|
<div class="line"><a name="l00266"></a><span class="lineno"> 266</span>  admin_instances_instance_statuses,</div>
|
|
<div class="line"><a name="l00267"></a><span class="lineno"> 267</span>  admin_statuses,</div>
|
|
<div class="line"><a name="l00268"></a><span class="lineno"> 268</span>  admin_relay,</div>
|
|
<div class="line"><a name="l00269"></a><span class="lineno"> 269</span>  admin_users_invite_token,</div>
|
|
<div class="line"><a name="l00270"></a><span class="lineno"> 270</span>  admin_users_invites,</div>
|
|
<div class="line"><a name="l00271"></a><span class="lineno"> 271</span>  admin_users_revoke_invite,</div>
|
|
<div class="line"><a name="l00272"></a><span class="lineno"> 272</span>  admin_users_email_invite,</div>
|
|
<div class="line"><a name="l00273"></a><span class="lineno"> 273</span>  admin_users_nickname_password_reset,</div>
|
|
<div class="line"><a name="l00274"></a><span class="lineno"> 274</span>  admin_users_nickname_update_credentials,</div>
|
|
<div class="line"><a name="l00275"></a><span class="lineno"> 275</span>  admin_users_force_password_reset,</div>
|
|
<div class="line"><a name="l00276"></a><span class="lineno"> 276</span>  admin_reports,</div>
|
|
<div class="line"><a name="l00277"></a><span class="lineno"> 277</span>  admin_grouped_reports,</div>
|
|
<div class="line"><a name="l00278"></a><span class="lineno"> 278</span>  admin_reports_id,</div>
|
|
<div class="line"><a name="l00279"></a><span class="lineno"> 279</span>  admin_reports_id_notes,</div>
|
|
<div class="line"><a name="l00280"></a><span class="lineno"> 280</span>  admin_reports_report_id_notes_id,</div>
|
|
<div class="line"><a name="l00281"></a><span class="lineno"> 281</span>  admin_statuses_id,</div>
|
|
<div class="line"><a name="l00282"></a><span class="lineno"> 282</span>  admin_restart,</div>
|
|
<div class="line"><a name="l00283"></a><span class="lineno"> 283</span>  admin_config,</div>
|
|
<div class="line"><a name="l00284"></a><span class="lineno"> 284</span>  admin_config_descriptions,</div>
|
|
<div class="line"><a name="l00285"></a><span class="lineno"> 285</span>  admin_moderation_log,</div>
|
|
<div class="line"><a name="l00286"></a><span class="lineno"> 286</span>  admin_reload_emoji,</div>
|
|
<div class="line"><a name="l00287"></a><span class="lineno"> 287</span>  admin_users_confirm_email,</div>
|
|
<div class="line"><a name="l00288"></a><span class="lineno"> 288</span>  admin_users_resend_confirm_email,</div>
|
|
<div class="line"><a name="l00289"></a><span class="lineno"> 289</span>  admin_stats,</div>
|
|
<div class="line"><a name="l00290"></a><span class="lineno"> 290</span>  </div>
|
|
<div class="line"><a name="l00291"></a><span class="lineno"> 291</span>  <span class="comment">// No longer documented for Pleroma 2.0.0.</span></div>
|
|
<div class="line"><a name="l00292"></a><span class="lineno"> 292</span>  admin_users_nickname,</div>
|
|
<div class="line"><a name="l00293"></a><span class="lineno"> 293</span>  admin_users_nickname_activation_status,</div>
|
|
<div class="line"><a name="l00294"></a><span class="lineno"> 294</span>  admin_reports_id_respond,</div>
|
|
<div class="line"><a name="l00295"></a><span class="lineno"> 295</span>  admin_config_migrate_to_db,</div>
|
|
<div class="line"><a name="l00296"></a><span class="lineno"> 296</span>  admin_config_migrate_from_db,</div>
|
|
<div class="line"><a name="l00297"></a><span class="lineno"> 297</span>  </div>
|
|
<div class="line"><a name="l00298"></a><span class="lineno"> 298</span>  emoji,</div>
|
|
<div class="line"><a name="l00299"></a><span class="lineno"> 299</span>  follow_import,</div>
|
|
<div class="line"><a name="l00300"></a><span class="lineno"> 300</span>  captcha,</div>
|
|
<div class="line"><a name="l00301"></a><span class="lineno"> 301</span>  delete_account,</div>
|
|
<div class="line"><a name="l00302"></a><span class="lineno"> 302</span>  disable_account,</div>
|
|
<div class="line"><a name="l00303"></a><span class="lineno"> 303</span>  notification_settings,</div>
|
|
<div class="line"><a name="l00304"></a><span class="lineno"> 304</span>  healthcheck,</div>
|
|
<div class="line"><a name="l00305"></a><span class="lineno"> 305</span>  change_email,</div>
|
|
<div class="line"><a name="l00306"></a><span class="lineno"> 306</span>  emoji_packs,</div>
|
|
<div class="line"><a name="l00307"></a><span class="lineno"> 307</span>  emoji_packs_name,</div>
|
|
<div class="line"><a name="l00308"></a><span class="lineno"> 308</span>  emoji_packs_name_update_file,</div>
|
|
<div class="line"><a name="l00309"></a><span class="lineno"> 309</span>  emoji_packs_name_update_metadata,</div>
|
|
<div class="line"><a name="l00310"></a><span class="lineno"> 310</span>  emoji_packs_download_from,</div>
|
|
<div class="line"><a name="l00311"></a><span class="lineno"> 311</span>  emoji_packs_list_from,</div>
|
|
<div class="line"><a name="l00312"></a><span class="lineno"> 312</span>  emoji_packs_name_download_shared,</div>
|
|
<div class="line"><a name="l00313"></a><span class="lineno"> 313</span>  </div>
|
|
<div class="line"><a name="l00314"></a><span class="lineno"> 314</span>  <span class="comment">// No longer documented for Pleroma 2.0.0.</span></div>
|
|
<div class="line"><a name="l00315"></a><span class="lineno"> 315</span>  account_register,</div>
|
|
<div class="line"><a name="l00316"></a><span class="lineno"> 316</span>  </div>
|
|
<div class="line"><a name="l00317"></a><span class="lineno"> 317</span>  };</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="aee8f590426914a36f948dafa78e330f2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aee8f590426914a36f948dafa78e330f2">◆ </a></span>v1</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="classmastodonpp_1_1API.html#aee8f590426914a36f948dafa78e330f2">mastodonpp::API::v1</a></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>An enumeration of all v1 API endpoints. </p>
|
|
<p>The original <code>/</code> are substituted with <code>_</code>. <code>:</code> are omitted.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>0.1.0 </dd></dl>
|
|
<div class="fragment"><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  {</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  apps,</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  apps_verify_credentials,</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  </div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  accounts,</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  accounts_verify_credentials,</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  accounts_update_credentials,</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  accounts_id,</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  accounts_id_statuses,</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  accounts_id_followers,</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  accounts_id_following,</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  accounts_id_lists,</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  accounts_id_identity_proofs,</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  accounts_id_follow,</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  accounts_id_unfollow,</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  accounts_id_block,</div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  accounts_id_unblock,</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  accounts_id_mute,</div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  accounts_id_unmute,</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  accounts_id_pin,</div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  accounts_id_unpin,</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  accounts_relationships,</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  accounts_search,</div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  </div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  bookmarks,</div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  </div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  favourites,</div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  </div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  mutes,</div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  </div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  blocks,</div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  </div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  domain_blocks,</div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  </div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  filters,</div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  filters_id,</div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  </div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  reports,</div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  </div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  follow_requests,</div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  follow_requests_id_authorize,</div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  follow_requests_id_reject,</div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  </div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  endorsements,</div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  </div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  featured_tags,</div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  featured_tags_id,</div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  featured_tags_suggestions,</div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  </div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  preferences,</div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  </div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  suggestions,</div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  suggestions_account_id,</div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  </div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  statuses,</div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  statuses_id,</div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  statuses_id_context,</div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  statuses_id_reblogged_by,</div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  statuses_id_favourited_by,</div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  statuses_id_favourite,</div>
|
|
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  statuses_id_unfavourite,</div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  statuses_id_reblog,</div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  statuses_id_unreblog,</div>
|
|
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  statuses_id_bookmark,</div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  statuses_id_unbookmark,</div>
|
|
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  statuses_id_mute,</div>
|
|
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  statuses_id_unmute,</div>
|
|
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  statuses_id_pin,</div>
|
|
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  statuses_id_unpin,</div>
|
|
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  </div>
|
|
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  media,</div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  media_id,</div>
|
|
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  </div>
|
|
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  polls_id,</div>
|
|
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  polls_id_votes,</div>
|
|
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  </div>
|
|
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  scheduled_statuses,</div>
|
|
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  scheduled_statuses_id,</div>
|
|
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  </div>
|
|
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  timelines_public,</div>
|
|
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  timelines_tag_hashtag,</div>
|
|
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  timelines_home,</div>
|
|
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  timelines_list_list_id,</div>
|
|
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  </div>
|
|
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  conversations,</div>
|
|
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  conversations_id,</div>
|
|
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  conversations_id_read,</div>
|
|
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  </div>
|
|
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  lists,</div>
|
|
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  lists_id,</div>
|
|
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  lists_id_accounts,</div>
|
|
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  </div>
|
|
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  markers,</div>
|
|
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  </div>
|
|
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  streaming_health,</div>
|
|
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  streaming_user,</div>
|
|
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  streaming_public,</div>
|
|
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  streaming_public_local,</div>
|
|
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  streaming_hashtag,</div>
|
|
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  streaming_hashtag_local,</div>
|
|
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  streaming_list,</div>
|
|
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  streaming_direct,</div>
|
|
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  </div>
|
|
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  notifications,</div>
|
|
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  notifications_id,</div>
|
|
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  notifications_clear,</div>
|
|
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  notifications_id_dismiss,</div>
|
|
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  </div>
|
|
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  push_subscription,</div>
|
|
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  </div>
|
|
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  instance,</div>
|
|
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  instance_peers,</div>
|
|
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  instance_activity,</div>
|
|
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  </div>
|
|
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  trends,</div>
|
|
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  </div>
|
|
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  directory,</div>
|
|
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  </div>
|
|
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  custom_emojis,</div>
|
|
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  </div>
|
|
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  admin_accounts,</div>
|
|
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  admin_accounts_id,</div>
|
|
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  admin_accounts_account_id_action,</div>
|
|
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  admin_accounts_id_approve,</div>
|
|
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  admin_accounts_id_reject,</div>
|
|
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  admin_accounts_id_enable,</div>
|
|
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>  admin_accounts_id_unsilence,</div>
|
|
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  admin_accounts_id_unsuspend,</div>
|
|
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  admin_reports,</div>
|
|
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  admin_reports_id,</div>
|
|
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  admin_reports_id_assign_to_self,</div>
|
|
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  admin_reports_id_unassign,</div>
|
|
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  admin_reports_id_resolve,</div>
|
|
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  admin_reports_id_reopen,</div>
|
|
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  </div>
|
|
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  pleroma_notifications_read,</div>
|
|
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  pleroma_accounts_id_subscribe,</div>
|
|
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  pleroma_accounts_id_unsubscribe,</div>
|
|
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  pleroma_accounts_id_favourites,</div>
|
|
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>  pleroma_accounts_update_avatar,</div>
|
|
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span>  pleroma_accounts_update_banner,</div>
|
|
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span>  pleroma_accounts_update_background,</div>
|
|
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span>  pleroma_accounts_confirmation_resend,</div>
|
|
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  pleroma_mascot,</div>
|
|
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  pleroma_conversations_id_statuses,</div>
|
|
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  pleroma_conversations_id,</div>
|
|
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  pleroma_conversations_id_read,</div>
|
|
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  pleroma_accounts_id_scrobbles,</div>
|
|
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  pleroma_scrobble,</div>
|
|
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  pleroma_statuses_id_reactions_emoji,</div>
|
|
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span>  pleroma_statuses_id_reactions,</div>
|
|
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  };</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a67ba7c7a8d94ec7905e45466255648ba"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a67ba7c7a8d94ec7905e45466255648ba">◆ </a></span>v2</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="classmastodonpp_1_1API.html#a67ba7c7a8d94ec7905e45466255648ba">mastodonpp::API::v2</a></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>An enumeration of all v2 API endpoints. </p>
|
|
<p>The original <code>/</code> are substituted with <code>_</code>. <code>:</code> are omitted.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>0.1.0 </dd></dl>
|
|
<div class="fragment"><div class="line"><a name="l00212"></a><span class="lineno"> 212</span>  {</div>
|
|
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span>  search</div>
|
|
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span>  };</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="af9fc7a7d152a851122f8acc3224d4047"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af9fc7a7d152a851122f8acc3224d4047">◆ </a></span>API()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">mastodonpp::API::API </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classmastodonpp_1_1API.html#a7f74ce81c1f0cbc0ed6ad66b2bd24318">endpoint_type</a> & </td>
|
|
<td class="paramname"><em>endpoint</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Constructs an <a class="el" href="classmastodonpp_1_1API.html" title="Holds API endpoints.">API</a> object. You should never need this. </p>
|
|
<p>This constructor exists to hide away the class members, which are used internally.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>0.1.0 </dd></dl>
|
|
<div class="fragment"><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  : _endpoint{endpoint}</div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> {}</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="aa51c43b5c7cc2afd32520d08d51bcfc3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa51c43b5c7cc2afd32520d08d51bcfc3">◆ </a></span>to_string_view()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string_view mastodonpp::API::to_string_view </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Convert <a class="el" href="classmastodonpp_1_1API.html#a7f74ce81c1f0cbc0ed6ad66b2bd24318" title="Type for endpoints. Can be API::v1, API::v2, API::oauth, API::other or API::pleroma.">endpoint_type</a> to <code>std::string_view</code>. </p>
|
|
<dl class="section since"><dt>Since</dt><dd>0.1.0 </dd></dl>
|
|
<div class="fragment"><div class="line"><a name="l00343"></a><span class="lineno"> 343</span>  {</div>
|
|
<div class="line"><a name="l00344"></a><span class="lineno"> 344</span>  <span class="keywordflow">return</span> _endpoint_map.at(_endpoint);</div>
|
|
<div class="line"><a name="l00345"></a><span class="lineno"> 345</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>include/<a class="el" href="api_8hpp_source.html">api.hpp</a></li>
|
|
<li>src/api.cpp</li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
|
|
</small></address>
|
|
</body>
|
|
</html>
|