1605 lines
232 KiB
HTML
1605 lines
232 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.14"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>mastodon-cpp: Mastodon::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="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">mastodon-cpp
|
|
 <span id="projectnumber">0.30.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.14 -->
|
|
<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('',false,false,'search.php','Search');
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><b>Mastodon</b></li><li class="navelem"><a class="el" href="classMastodon_1_1API.html">API</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
|
<a href="classMastodon_1_1API-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Mastodon::API Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Class for the Mastodon <a class="el" href="classMastodon_1_1API.html" title="Class for the Mastodon API. ">API</a>.
|
|
<a href="classMastodon_1_1API.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="mastodon-cpp_8hpp_source.html">mastodon-cpp.hpp</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for Mastodon::API:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classMastodon_1_1API.png" usemap="#Mastodon::API_map" alt=""/>
|
|
<map id="Mastodon::API_map" name="Mastodon::API_map">
|
|
<area href="classMastodon_1_1Easy.html" title="Child of Mastodon::API with abstract methods. " alt="Mastodon::Easy" shape="rect" coords="0,56,101,80"/>
|
|
</map>
|
|
</div></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
|
Classes</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1API_1_1http.html">http</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">http class. Do not use this directly. <a href="classMastodon_1_1API_1_1http.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><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:a3b88e9c1ff8daee1e730c3f3de1e2853"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1API.html#a3b88e9c1ff8daee1e730c3f3de1e2853">v1</a> { <br />
|
|
  <b>accounts_id</b>,
|
|
<b>accounts_verify_credentials</b>,
|
|
<b>accounts_id_followers</b>,
|
|
<b>accounts_id_following</b>,
|
|
<br />
|
|
  <b>accounts_id_statuses</b>,
|
|
<b>accounts_relationships</b>,
|
|
<b>accounts_search</b>,
|
|
<b>blocks</b>,
|
|
<br />
|
|
  <b>domain_blocks</b>,
|
|
<b>endorsements</b>,
|
|
<b>favourites</b>,
|
|
<b>follow_requests</b>,
|
|
<br />
|
|
  <b>instance</b>,
|
|
<b>custom_emojis</b>,
|
|
<b>lists</b>,
|
|
<b>accounts_id_lists</b>,
|
|
<br />
|
|
  <b>lists_id_accounts</b>,
|
|
<b>lists_id</b>,
|
|
<b>mutes</b>,
|
|
<b>notifications</b>,
|
|
<br />
|
|
  <b>notifications_id</b>,
|
|
<b>reports</b>,
|
|
<b>search</b>,
|
|
<b>statuses_id</b>,
|
|
<br />
|
|
  <b>statuses_id_context</b>,
|
|
<b>statuses_id_card</b>,
|
|
<b>statuses_id_reblogged_by</b>,
|
|
<b>statuses_id_favourited_by</b>,
|
|
<br />
|
|
  <b>timelines_home</b>,
|
|
<b>timelines_public</b>,
|
|
<b>timelines_tag_hashtag</b>,
|
|
<b>timelines_list_list_id</b>,
|
|
<br />
|
|
  <b>accounts_update_credentials</b>,
|
|
<b>accounts_id_follow</b>,
|
|
<b>accounts_id_unfollow</b>,
|
|
<b>accounts_id_block</b>,
|
|
<br />
|
|
  <b>accounts_id_unblock</b>,
|
|
<b>accounts_id_mute</b>,
|
|
<b>accounts_id_unmute</b>,
|
|
<b>accounts_id_pin</b>,
|
|
<br />
|
|
  <b>accounts_id_unpin</b>,
|
|
<b>apps</b>,
|
|
<b>follow_requests_id_authorize</b>,
|
|
<b>follow_requests_id_reject</b>,
|
|
<br />
|
|
  <b>follows</b>,
|
|
<b>media</b>,
|
|
<b>notifications_clear</b>,
|
|
<b>notifications_dismiss</b>,
|
|
<br />
|
|
  <b>statuses</b>,
|
|
<b>statuses_id_reblog</b>,
|
|
<b>statuses_id_unreblog</b>,
|
|
<b>statuses_id_favourite</b>,
|
|
<br />
|
|
  <b>statuses_id_unfavourite</b>,
|
|
<b>statuses_id_pin</b>,
|
|
<b>statuses_id_unpin</b>,
|
|
<b>statuses_id_mute</b>,
|
|
<br />
|
|
  <b>statuses_id_unmute</b>,
|
|
<b>media_id</b>,
|
|
<b>streaming_user</b>,
|
|
<b>streaming_public</b>,
|
|
<br />
|
|
  <b>streaming_public_local</b>,
|
|
<b>streaming_hashtag</b>,
|
|
<b>streaming_list</b>,
|
|
<b>push_subscription</b>,
|
|
<br />
|
|
  <b>bookmarks</b>,
|
|
<b>statuses_id_bookmark</b>,
|
|
<b>statuses_id_unbookmark</b>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:a3b88e9c1ff8daee1e730c3f3de1e2853"><td class="mdescLeft"> </td><td class="mdescRight">A list of all v1 <a class="el" href="classMastodon_1_1API.html" title="Class for the Mastodon API. ">API</a> calls. <a href="classMastodon_1_1API.html#a3b88e9c1ff8daee1e730c3f3de1e2853">More...</a><br /></td></tr>
|
|
<tr class="separator:a3b88e9c1ff8daee1e730c3f3de1e2853"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa9bb595d2e7632ab9aa37a9bb6836ed0"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1API.html#aa9bb595d2e7632ab9aa37a9bb6836ed0">v2</a> { <b>search</b>
|
|
}</td></tr>
|
|
<tr class="memdesc:aa9bb595d2e7632ab9aa37a9bb6836ed0"><td class="mdescLeft"> </td><td class="mdescRight">A list of all v2 <a class="el" href="classMastodon_1_1API.html" title="Class for the Mastodon API. ">API</a> calls. <a href="classMastodon_1_1API.html#aa9bb595d2e7632ab9aa37a9bb6836ed0">More...</a><br /></td></tr>
|
|
<tr class="separator:aa9bb595d2e7632ab9aa37a9bb6836ed0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a27b9c64d94494836c28e2fb78e01dc60"><td class="memItemLeft" align="right" valign="top">typedef std::map< string, std::vector< string > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60">parametermap</a></td></tr>
|
|
<tr class="memdesc:a27b9c64d94494836c28e2fb78e01dc60"><td class="mdescLeft"> </td><td class="mdescRight">Used for passing parameters. <a href="#a27b9c64d94494836c28e2fb78e01dc60">More...</a><br /></td></tr>
|
|
<tr class="separator:a27b9c64d94494836c28e2fb78e01dc60"><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:a627a687d2f211d714d2e1d2bd3faf7ff"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1API.html#a627a687d2f211d714d2e1d2bd3faf7ff">API</a> (const string &instance, const string &access_token)</td></tr>
|
|
<tr class="memdesc:a627a687d2f211d714d2e1d2bd3faf7ff"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new <a class="el" href="classMastodon_1_1API.html" title="Class for the Mastodon API. ">API</a> object. <a href="#a627a687d2f211d714d2e1d2bd3faf7ff">More...</a><br /></td></tr>
|
|
<tr class="separator:a627a687d2f211d714d2e1d2bd3faf7ff"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae25c5e6eabb8e783d7034ee1c79ae741"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1API.html#ae25c5e6eabb8e783d7034ee1c79ae741">set_useragent</a> (const string &useragent)</td></tr>
|
|
<tr class="memdesc:ae25c5e6eabb8e783d7034ee1c79ae741"><td class="mdescLeft"> </td><td class="mdescRight">Sets the useragent. Default is mastodon-cpp/version. <a href="#ae25c5e6eabb8e783d7034ee1c79ae741">More...</a><br /></td></tr>
|
|
<tr class="separator:ae25c5e6eabb8e783d7034ee1c79ae741"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad7f0c4bbdfff6ebb769e34624329a4d0"><td class="memItemLeft" align="right" valign="top">const string </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1API.html#ad7f0c4bbdfff6ebb769e34624329a4d0">get_useragent</a> () const</td></tr>
|
|
<tr class="memdesc:ad7f0c4bbdfff6ebb769e34624329a4d0"><td class="mdescLeft"> </td><td class="mdescRight">Gets the useragent. <a href="#ad7f0c4bbdfff6ebb769e34624329a4d0">More...</a><br /></td></tr>
|
|
<tr class="separator:ad7f0c4bbdfff6ebb769e34624329a4d0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a06ad0990a9c21f20fbd2e17f03d1f75b"><td class="memItemLeft" align="right" valign="top">const string </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1API.html#a06ad0990a9c21f20fbd2e17f03d1f75b">get_instance</a> () const</td></tr>
|
|
<tr class="memdesc:a06ad0990a9c21f20fbd2e17f03d1f75b"><td class="mdescLeft"> </td><td class="mdescRight">Returns the instance. <a href="#a06ad0990a9c21f20fbd2e17f03d1f75b">More...</a><br /></td></tr>
|
|
<tr class="separator:a06ad0990a9c21f20fbd2e17f03d1f75b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa86264a4f70537a3278f17f7fabaad0a"><td class="memItemLeft" align="right" valign="top">uint_fast16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1API.html#aa86264a4f70537a3278f17f7fabaad0a">register_app1</a> (const string &client_name, const string &redirect_uri, const string &scopes, const string &website, string &client_id, string &client_secret, string &url)</td></tr>
|
|
<tr class="memdesc:aa86264a4f70537a3278f17f7fabaad0a"><td class="mdescLeft"> </td><td class="mdescRight">Register application, step 1/2. <a href="#aa86264a4f70537a3278f17f7fabaad0a">More...</a><br /></td></tr>
|
|
<tr class="separator:aa86264a4f70537a3278f17f7fabaad0a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1abbce62edcc86798d4277ab2de790b5"><td class="memItemLeft" align="right" valign="top"><a id="a1abbce62edcc86798d4277ab2de790b5"></a>
|
|
uint_fast16_t </td><td class="memItemRight" valign="bottom"><b>register_app1</b> (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)</td></tr>
|
|
<tr class="separator:a1abbce62edcc86798d4277ab2de790b5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a98c5052e9c0ebae2dbc5a24e3a4066e2"><td class="memItemLeft" align="right" valign="top">uint_fast16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1API.html#a98c5052e9c0ebae2dbc5a24e3a4066e2">register_app2</a> (const string &client_id, const string &client_secret, const string &redirect_uri, const string &code, string &access_token)</td></tr>
|
|
<tr class="memdesc:a98c5052e9c0ebae2dbc5a24e3a4066e2"><td class="mdescLeft"> </td><td class="mdescRight">Register application, step 2/2. <a href="#a98c5052e9c0ebae2dbc5a24e3a4066e2">More...</a><br /></td></tr>
|
|
<tr class="separator:a98c5052e9c0ebae2dbc5a24e3a4066e2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a12212dab3cb8076ab9a83159fd6d9411"><td class="memItemLeft" align="right" valign="top"><a id="a12212dab3cb8076ab9a83159fd6d9411"></a>
|
|
uint_fast16_t </td><td class="memItemRight" valign="bottom"><b>register_app2</b> (const string &instance, const string &client_id, const string &client_secret, const string &redirect_uri, const string &code, string &access_token)</td></tr>
|
|
<tr class="separator:a12212dab3cb8076ab9a83159fd6d9411"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad7392af31cff2a6b446aea1e6b58cbaf"><td class="memItemLeft" align="right" valign="top">const string </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1API.html#ad7392af31cff2a6b446aea1e6b58cbaf">get_header</a> (const string &header) const</td></tr>
|
|
<tr class="memdesc:ad7392af31cff2a6b446aea1e6b58cbaf"><td class="mdescLeft"> </td><td class="mdescRight">Gets the header from the last answer. <a href="#ad7392af31cff2a6b446aea1e6b58cbaf">More...</a><br /></td></tr>
|
|
<tr class="separator:ad7392af31cff2a6b446aea1e6b58cbaf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4e8d254c512c2038323437a1be1641d7"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1API.html#a4e8d254c512c2038323437a1be1641d7">exceptions</a> (const bool &value)</td></tr>
|
|
<tr class="memdesc:a4e8d254c512c2038323437a1be1641d7"><td class="mdescLeft"> </td><td class="mdescRight">Turn exceptions on or off. Defaults to off. <a href="#a4e8d254c512c2038323437a1be1641d7">More...</a><br /></td></tr>
|
|
<tr class="separator:a4e8d254c512c2038323437a1be1641d7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a98bc9bbca936ddacab18df7854ec80fe"><td class="memItemLeft" align="right" valign="top"><a id="a98bc9bbca936ddacab18df7854ec80fe"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1API.html#a98bc9bbca936ddacab18df7854ec80fe">exceptions</a> () const</td></tr>
|
|
<tr class="memdesc:a98bc9bbca936ddacab18df7854ec80fe"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if exceptions are turned on, false otherwise. <br /></td></tr>
|
|
<tr class="separator:a98bc9bbca936ddacab18df7854ec80fe"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a980009607243247a1295468a7adcd43c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1API.html#a980009607243247a1295468a7adcd43c">set_proxy</a> (const string &proxy, const string &userpw="")</td></tr>
|
|
<tr class="memdesc:a980009607243247a1295468a7adcd43c"><td class="mdescLeft"> </td><td class="mdescRight">Sets the proxy. <a href="#a980009607243247a1295468a7adcd43c">More...</a><br /></td></tr>
|
|
<tr class="separator:a980009607243247a1295468a7adcd43c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acc672d3637568d39ba9248ab39094b9f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1API.html#acc672d3637568d39ba9248ab39094b9f">get_proxy</a> (string &proxy, string &userpw) const</td></tr>
|
|
<tr class="memdesc:acc672d3637568d39ba9248ab39094b9f"><td class="mdescLeft"> </td><td class="mdescRight">For internal use. <a href="#acc672d3637568d39ba9248ab39094b9f">More...</a><br /></td></tr>
|
|
<tr class="separator:acc672d3637568d39ba9248ab39094b9f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae42bb8841ebead64dbb555cb6284784e"><td class="memItemLeft" align="right" valign="top">uint_fast16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1API.html#ae42bb8841ebead64dbb555cb6284784e">get</a> (const <a class="el" href="classMastodon_1_1API.html#a3b88e9c1ff8daee1e730c3f3de1e2853">Mastodon::API::v1</a> &call, string &answer)</td></tr>
|
|
<tr class="memdesc:ae42bb8841ebead64dbb555cb6284784e"><td class="mdescLeft"> </td><td class="mdescRight">Make a GET request which doesn't require parameters. <a href="#ae42bb8841ebead64dbb555cb6284784e">More...</a><br /></td></tr>
|
|
<tr class="separator:ae42bb8841ebead64dbb555cb6284784e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad428d084640d4d1c0b59ed5f358b5d78"><td class="memItemLeft" align="right" valign="top">uint_fast16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1API.html#ad428d084640d4d1c0b59ed5f358b5d78">get</a> (const <a class="el" href="classMastodon_1_1API.html#a3b88e9c1ff8daee1e730c3f3de1e2853">Mastodon::API::v1</a> &call, const <a class="el" href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60">parametermap</a> &parameters, string &answer)</td></tr>
|
|
<tr class="memdesc:ad428d084640d4d1c0b59ed5f358b5d78"><td class="mdescLeft"> </td><td class="mdescRight">Make a GET request which requires parameters. <a href="#ad428d084640d4d1c0b59ed5f358b5d78">More...</a><br /></td></tr>
|
|
<tr class="separator:ad428d084640d4d1c0b59ed5f358b5d78"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7247207e69dfdec12d6153c0b7763cac"><td class="memItemLeft" align="right" valign="top">uint_fast16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1API.html#a7247207e69dfdec12d6153c0b7763cac">get</a> (const <a class="el" href="classMastodon_1_1API.html#aa9bb595d2e7632ab9aa37a9bb6836ed0">Mastodon::API::v2</a> &call, const <a class="el" href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60">parametermap</a> &parameters, string &answer)</td></tr>
|
|
<tr class="memdesc:a7247207e69dfdec12d6153c0b7763cac"><td class="mdescLeft"> </td><td class="mdescRight">Make a GET request which requires parameters. <a href="#a7247207e69dfdec12d6153c0b7763cac">More...</a><br /></td></tr>
|
|
<tr class="separator:a7247207e69dfdec12d6153c0b7763cac"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abbeae53e9ee2402de9f7a38db16d2096"><td class="memItemLeft" align="right" valign="top">uint_fast16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1API.html#abbeae53e9ee2402de9f7a38db16d2096">get</a> (const string &call, string &answer)</td></tr>
|
|
<tr class="memdesc:abbeae53e9ee2402de9f7a38db16d2096"><td class="mdescLeft"> </td><td class="mdescRight">Make a custom GET request. <a href="#abbeae53e9ee2402de9f7a38db16d2096">More...</a><br /></td></tr>
|
|
<tr class="separator:abbeae53e9ee2402de9f7a38db16d2096"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a061f264be39ee78a059976c6b58bea33"><td class="memItemLeft" align="right" valign="top"><a id="a061f264be39ee78a059976c6b58bea33"></a>
|
|
uint_fast16_t </td><td class="memItemRight" valign="bottom"><b>get</b> (const <a class="el" href="classMastodon_1_1API.html#a3b88e9c1ff8daee1e730c3f3de1e2853">Mastodon::API::v1</a> &call, const string &argument, string &answer)</td></tr>
|
|
<tr class="separator:a061f264be39ee78a059976c6b58bea33"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aef8cb8fb308e73c040089f3eb2e189c3"><td class="memItemLeft" align="right" valign="top"><a id="aef8cb8fb308e73c040089f3eb2e189c3"></a>
|
|
uint_fast16_t </td><td class="memItemRight" valign="bottom"><b>get</b> (const <a class="el" href="classMastodon_1_1API.html#a3b88e9c1ff8daee1e730c3f3de1e2853">Mastodon::API::v1</a> &call, const string &argument, const <a class="el" href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60">parametermap</a> &parameters, string &answer)</td></tr>
|
|
<tr class="separator:aef8cb8fb308e73c040089f3eb2e189c3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3f4df7ecf727cfcc4b9c20a18d0dbb34"><td class="memItemLeft" align="right" valign="top">uint_fast16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1API.html#a3f4df7ecf727cfcc4b9c20a18d0dbb34">get_stream</a> (const <a class="el" href="classMastodon_1_1API.html#a3b88e9c1ff8daee1e730c3f3de1e2853">Mastodon::API::v1</a> &call, const <a class="el" href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60">parametermap</a> &parameters, string &answer, std::unique_ptr< <a class="el" href="classMastodon_1_1API_1_1http.html">Mastodon::API::http</a> > &ptr)</td></tr>
|
|
<tr class="memdesc:a3f4df7ecf727cfcc4b9c20a18d0dbb34"><td class="mdescLeft"> </td><td class="mdescRight">Make a streaming GET request. <a href="#a3f4df7ecf727cfcc4b9c20a18d0dbb34">More...</a><br /></td></tr>
|
|
<tr class="separator:a3f4df7ecf727cfcc4b9c20a18d0dbb34"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1d72b3777918283e31a61447dce3ce7a"><td class="memItemLeft" align="right" valign="top">uint_fast16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1API.html#a1d72b3777918283e31a61447dce3ce7a">get_stream</a> (const <a class="el" href="classMastodon_1_1API.html#a3b88e9c1ff8daee1e730c3f3de1e2853">Mastodon::API::v1</a> &call, string &answer, std::unique_ptr< <a class="el" href="classMastodon_1_1API_1_1http.html">Mastodon::API::http</a> > &ptr)</td></tr>
|
|
<tr class="memdesc:a1d72b3777918283e31a61447dce3ce7a"><td class="mdescLeft"> </td><td class="mdescRight">Make a streaming GET request. <a href="#a1d72b3777918283e31a61447dce3ce7a">More...</a><br /></td></tr>
|
|
<tr class="separator:a1d72b3777918283e31a61447dce3ce7a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af43a3254769976e1ad6056b99f57661c"><td class="memItemLeft" align="right" valign="top">uint_fast16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1API.html#af43a3254769976e1ad6056b99f57661c">get_stream</a> (const string &call, string &answer, std::unique_ptr< <a class="el" href="classMastodon_1_1API_1_1http.html">Mastodon::API::http</a> > &ptr)</td></tr>
|
|
<tr class="memdesc:af43a3254769976e1ad6056b99f57661c"><td class="mdescLeft"> </td><td class="mdescRight">Make a streaming GET request. <a href="#af43a3254769976e1ad6056b99f57661c">More...</a><br /></td></tr>
|
|
<tr class="separator:af43a3254769976e1ad6056b99f57661c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae8d1ea23e6f494e62095340b86be825a"><td class="memItemLeft" align="right" valign="top"><a id="ae8d1ea23e6f494e62095340b86be825a"></a>
|
|
uint_fast16_t </td><td class="memItemRight" valign="bottom"><b>get_stream</b> (const <a class="el" href="classMastodon_1_1API.html#a3b88e9c1ff8daee1e730c3f3de1e2853">Mastodon::API::v1</a> &call, const string &argument, string &answer, std::unique_ptr< <a class="el" href="classMastodon_1_1API_1_1http.html">Mastodon::API::http</a> > &ptr)</td></tr>
|
|
<tr class="separator:ae8d1ea23e6f494e62095340b86be825a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a40c34f41d9a0c6b6cf83e8dbf826267f"><td class="memItemLeft" align="right" valign="top">uint_fast16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1API.html#a40c34f41d9a0c6b6cf83e8dbf826267f">patch</a> (const <a class="el" href="classMastodon_1_1API.html#a3b88e9c1ff8daee1e730c3f3de1e2853">Mastodon::API::v1</a> &call, const <a class="el" href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60">parametermap</a> &parameters, string &answer)</td></tr>
|
|
<tr class="memdesc:a40c34f41d9a0c6b6cf83e8dbf826267f"><td class="mdescLeft"> </td><td class="mdescRight">Make a PATCH request. <a href="#a40c34f41d9a0c6b6cf83e8dbf826267f">More...</a><br /></td></tr>
|
|
<tr class="separator:a40c34f41d9a0c6b6cf83e8dbf826267f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaf5ba9253c05c733bc6a7819fd7455cd"><td class="memItemLeft" align="right" valign="top">uint_fast16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1API.html#aaf5ba9253c05c733bc6a7819fd7455cd">post</a> (const <a class="el" href="classMastodon_1_1API.html#a3b88e9c1ff8daee1e730c3f3de1e2853">Mastodon::API::v1</a> &call, string &answer)</td></tr>
|
|
<tr class="memdesc:aaf5ba9253c05c733bc6a7819fd7455cd"><td class="mdescLeft"> </td><td class="mdescRight">Make a POST request which doesn't require parameters. <a href="#aaf5ba9253c05c733bc6a7819fd7455cd">More...</a><br /></td></tr>
|
|
<tr class="separator:aaf5ba9253c05c733bc6a7819fd7455cd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adab19f56aac3129bbe7b59e4d33600e8"><td class="memItemLeft" align="right" valign="top">uint_fast16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1API.html#adab19f56aac3129bbe7b59e4d33600e8">post</a> (const <a class="el" href="classMastodon_1_1API.html#a3b88e9c1ff8daee1e730c3f3de1e2853">Mastodon::API::v1</a> &call, const <a class="el" href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60">parametermap</a> &parameters, string &answer)</td></tr>
|
|
<tr class="memdesc:adab19f56aac3129bbe7b59e4d33600e8"><td class="mdescLeft"> </td><td class="mdescRight">Make a POST request which requires parameters. <a href="#adab19f56aac3129bbe7b59e4d33600e8">More...</a><br /></td></tr>
|
|
<tr class="separator:adab19f56aac3129bbe7b59e4d33600e8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa9d6bd66adab80d9eca9c345e08c4dc8"><td class="memItemLeft" align="right" valign="top">uint_fast16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1API.html#aa9d6bd66adab80d9eca9c345e08c4dc8">post</a> (const string &call, const <a class="el" href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60">parametermap</a> &parameters, string &answer)</td></tr>
|
|
<tr class="memdesc:aa9d6bd66adab80d9eca9c345e08c4dc8"><td class="mdescLeft"> </td><td class="mdescRight">Make a custom POST request. <a href="#aa9d6bd66adab80d9eca9c345e08c4dc8">More...</a><br /></td></tr>
|
|
<tr class="separator:aa9d6bd66adab80d9eca9c345e08c4dc8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae888e1cc399a9eeb1c1e7438870c82ae"><td class="memItemLeft" align="right" valign="top"><a id="ae888e1cc399a9eeb1c1e7438870c82ae"></a>
|
|
uint_fast16_t </td><td class="memItemRight" valign="bottom"><b>post</b> (const <a class="el" href="classMastodon_1_1API.html#a3b88e9c1ff8daee1e730c3f3de1e2853">Mastodon::API::v1</a> &call, const string &argument, string &answer)</td></tr>
|
|
<tr class="separator:ae888e1cc399a9eeb1c1e7438870c82ae"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a077201d45c8536f84fa0d25bb02005a9"><td class="memItemLeft" align="right" valign="top"><a id="a077201d45c8536f84fa0d25bb02005a9"></a>
|
|
uint_fast16_t </td><td class="memItemRight" valign="bottom"><b>post</b> (const <a class="el" href="classMastodon_1_1API.html#a3b88e9c1ff8daee1e730c3f3de1e2853">Mastodon::API::v1</a> &call, const string &argument, const <a class="el" href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60">parametermap</a> &parameters, string &answer)</td></tr>
|
|
<tr class="separator:a077201d45c8536f84fa0d25bb02005a9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abe648cccdc9645206564d3f5615e5056"><td class="memItemLeft" align="right" valign="top">uint_fast16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1API.html#abe648cccdc9645206564d3f5615e5056">put</a> (const <a class="el" href="classMastodon_1_1API.html#a3b88e9c1ff8daee1e730c3f3de1e2853">Mastodon::API::v1</a> &call, const <a class="el" href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60">parametermap</a> &parameters, string &answer)</td></tr>
|
|
<tr class="memdesc:abe648cccdc9645206564d3f5615e5056"><td class="mdescLeft"> </td><td class="mdescRight">Make a PUT request which requires a parameters. <a href="#abe648cccdc9645206564d3f5615e5056">More...</a><br /></td></tr>
|
|
<tr class="separator:abe648cccdc9645206564d3f5615e5056"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1f1503b9b84ac34e1a4d0793d28db532"><td class="memItemLeft" align="right" valign="top">uint_fast16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1API.html#a1f1503b9b84ac34e1a4d0793d28db532">put</a> (const string &call, const <a class="el" href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60">parametermap</a> &parameters, string &answer)</td></tr>
|
|
<tr class="memdesc:a1f1503b9b84ac34e1a4d0793d28db532"><td class="mdescLeft"> </td><td class="mdescRight">Make a custom PUT request. <a href="#a1f1503b9b84ac34e1a4d0793d28db532">More...</a><br /></td></tr>
|
|
<tr class="separator:a1f1503b9b84ac34e1a4d0793d28db532"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5af664d3f217aa86f00abc168d02a667"><td class="memItemLeft" align="right" valign="top"><a id="a5af664d3f217aa86f00abc168d02a667"></a>
|
|
uint_fast16_t </td><td class="memItemRight" valign="bottom"><b>put</b> (const <a class="el" href="classMastodon_1_1API.html#a3b88e9c1ff8daee1e730c3f3de1e2853">Mastodon::API::v1</a> &call, const string &argument, const <a class="el" href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60">parametermap</a> &parameters, string &answer)</td></tr>
|
|
<tr class="separator:a5af664d3f217aa86f00abc168d02a667"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a507e4dc3769b58d05d272da25fb251d6"><td class="memItemLeft" align="right" valign="top">uint_fast16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1API.html#a507e4dc3769b58d05d272da25fb251d6">del</a> (const <a class="el" href="classMastodon_1_1API.html#a3b88e9c1ff8daee1e730c3f3de1e2853">Mastodon::API::v1</a> &call, const <a class="el" href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60">parametermap</a> &parameters)</td></tr>
|
|
<tr class="memdesc:a507e4dc3769b58d05d272da25fb251d6"><td class="mdescLeft"> </td><td class="mdescRight">Make a DELETE request which requires parameters. <a href="#a507e4dc3769b58d05d272da25fb251d6">More...</a><br /></td></tr>
|
|
<tr class="separator:a507e4dc3769b58d05d272da25fb251d6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a16e812a0dfcc25988c92fd9810423772"><td class="memItemLeft" align="right" valign="top">uint_fast16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1API.html#a16e812a0dfcc25988c92fd9810423772">del</a> (const string &call, const <a class="el" href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60">parametermap</a> &parameters, string &answer)</td></tr>
|
|
<tr class="memdesc:a16e812a0dfcc25988c92fd9810423772"><td class="mdescLeft"> </td><td class="mdescRight">Make a custom DELETE request. <a href="#a16e812a0dfcc25988c92fd9810423772">More...</a><br /></td></tr>
|
|
<tr class="separator:a16e812a0dfcc25988c92fd9810423772"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ace3e027eca84fa3fa3262ebb8a4a7b01"><td class="memItemLeft" align="right" valign="top"><a id="ace3e027eca84fa3fa3262ebb8a4a7b01"></a>
|
|
uint_fast16_t </td><td class="memItemRight" valign="bottom"><b>del</b> (const <a class="el" href="classMastodon_1_1API.html#a3b88e9c1ff8daee1e730c3f3de1e2853">Mastodon::API::v1</a> &call, const string &argument)</td></tr>
|
|
<tr class="separator:ace3e027eca84fa3fa3262ebb8a4a7b01"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3d1daf3303852c65472ee4531f94a810"><td class="memItemLeft" align="right" valign="top"><a id="a3d1daf3303852c65472ee4531f94a810"></a>
|
|
uint_fast16_t </td><td class="memItemRight" valign="bottom"><b>del</b> (const <a class="el" href="classMastodon_1_1API.html#a3b88e9c1ff8daee1e730c3f3de1e2853">Mastodon::API::v1</a> &call, const string &argument, const <a class="el" href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60">parametermap</a> &parameters)</td></tr>
|
|
<tr class="separator:a3d1daf3303852c65472ee4531f94a810"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
|
|
Static Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a41e36cb4a94140e68084a85b959fa30b"><td class="memItemLeft" align="right" valign="top">static const string </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1API.html#a41e36cb4a94140e68084a85b959fa30b">urlencode</a> (const string &str)</td></tr>
|
|
<tr class="memdesc:a41e36cb4a94140e68084a85b959fa30b"><td class="mdescLeft"> </td><td class="mdescRight">Percent-encodes a string. This is done automatically, unless you make a custom request. <a href="#a41e36cb4a94140e68084a85b959fa30b">More...</a><br /></td></tr>
|
|
<tr class="separator:a41e36cb4a94140e68084a85b959fa30b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a19891b68ebb8088e0fd748317704084d"><td class="memItemLeft" align="right" valign="top">static const string </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1API.html#a19891b68ebb8088e0fd748317704084d">urldecode</a> (const string &str)</td></tr>
|
|
<tr class="memdesc:a19891b68ebb8088e0fd748317704084d"><td class="mdescLeft"> </td><td class="mdescRight">Decodes a percent-encoded string. <a href="#a19891b68ebb8088e0fd748317704084d">More...</a><br /></td></tr>
|
|
<tr class="separator:a19891b68ebb8088e0fd748317704084d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a52ea24477c513aa211cf724be7a570f6"><td class="memItemLeft" align="right" valign="top">static const string </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1API.html#a52ea24477c513aa211cf724be7a570f6">unescape_html</a> (const string &html)</td></tr>
|
|
<tr class="memdesc:a52ea24477c513aa211cf724be7a570f6"><td class="mdescLeft"> </td><td class="mdescRight">Replaces HTML entities with UTF-8 characters. <a href="#a52ea24477c513aa211cf724be7a570f6">More...</a><br /></td></tr>
|
|
<tr class="separator:a52ea24477c513aa211cf724be7a570f6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Class for the Mastodon <a class="el" href="classMastodon_1_1API.html" title="Class for the Mastodon API. ">API</a>. </p>
|
|
<p>All input is expected to be UTF-8. Binary data must be base64-encoded or a filename. It appears that media attachements can not be base64 encoded.</p>
|
|
<h1><a class="anchor" id="error"></a>
|
|
Error codes</h1>
|
|
<p>mastodon-cpp will never use error codes below 11, except 0. </p><table class="markdownTable">
|
|
<tr class="markdownTableHead">
|
|
<th class="markdownTableHeadRight">Code </th><th class="markdownTableHeadLeft">Explanation </th></tr>
|
|
<tr class="markdownTableBody" class="markdownTableRowOdd">
|
|
<td class="markdownTableBodyRight">0 </td><td class="markdownTableBodyLeft">No error </td></tr>
|
|
<tr class="markdownTableBody" class="markdownTableRowEven">
|
|
<td class="markdownTableBodyRight">11 </td><td class="markdownTableBodyLeft">Invalid call </td></tr>
|
|
<tr class="markdownTableBody" class="markdownTableRowOdd">
|
|
<td class="markdownTableBodyRight">12 </td><td class="markdownTableBodyLeft">Not implemented </td></tr>
|
|
<tr class="markdownTableBody" class="markdownTableRowEven">
|
|
<td class="markdownTableBodyRight">13 </td><td class="markdownTableBodyLeft">URL changed (HTTP 301 or 308) </td></tr>
|
|
<tr class="markdownTableBody" class="markdownTableRowOdd">
|
|
<td class="markdownTableBodyRight">14 </td><td class="markdownTableBodyLeft">Cancelled by user </td></tr>
|
|
<tr class="markdownTableBody" class="markdownTableRowEven">
|
|
<td class="markdownTableBodyRight">15 </td><td class="markdownTableBodyLeft">Network error (curlpp exception) </td></tr>
|
|
<tr class="markdownTableBody" class="markdownTableRowOdd">
|
|
<td class="markdownTableBodyRight">16 </td><td class="markdownTableBodyLeft">Timeout </td></tr>
|
|
<tr class="markdownTableBody" class="markdownTableRowEven">
|
|
<td class="markdownTableBodyRight">100 - 999 </td><td class="markdownTableBodyLeft">HTTP status codes </td></tr>
|
|
<tr class="markdownTableBody" class="markdownTableRowOdd">
|
|
<td class="markdownTableBodyRight">65535 </td><td class="markdownTableBodyLeft">Unknown error </td></tr>
|
|
</table>
|
|
<dl class="section since"><dt>Since</dt><dd>before 0.11.0 </dd></dl>
|
|
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="example01_dump_json_8cpp-example.html#_a0">example01_dump_json.cpp</a>, <a class="el" href="example02_parse_account_8cpp-example.html#_a0">example02_parse_account.cpp</a>, <a class="el" href="example03_mastocron_8cpp-example.html#_a0">example03_mastocron.cpp</a>, <a class="el" href="example04_update_credentials_8cpp-example.html#_a0">example04_update_credentials.cpp</a>, <a class="el" href="example05_follow_unfollow_8cpp-example.html#_a0">example05_follow_unfollow.cpp</a>, <a class="el" href="example06_toot_delete-toot_8cpp-example.html#_a0">example06_toot_delete-toot.cpp</a>, <a class="el" href="example07_register_app_8cpp-example.html#_a0">example07_register_app.cpp</a>, <a class="el" href="example08_rate_limiting_8cpp-example.html#_a0">example08_rate_limiting.cpp</a>, <a class="el" href="example09_streaming_api_8cpp-example.html#_a0">example09_streaming_api.cpp</a>, <a class="el" href="example10_simplify_8cpp-example.html#_a0">example10_simplify.cpp</a>, <a class="el" href="example11_post_media_8cpp-example.html#_a0">example11_post_media.cpp</a>, <a class="el" href="example12_easy_laststatus_8cpp-example.html#_a0">example12_easy_laststatus.cpp</a>, <a class="el" href="example13_easy_stream_8cpp-example.html#_a0">example13_easy_stream.cpp</a>, <a class="el" href="example14_easy_treeview_8cpp-example.html#_a0">example14_easy_treeview.cpp</a>, <a class="el" href="example15_proxy_8cpp-example.html#_a0">example15_proxy.cpp</a>, and <a class="el" href="example16_account_fields_8cpp-example.html#_a0">example16_account_fields.cpp</a>.</dd>
|
|
</dl></div><h2 class="groupheader">Member Typedef Documentation</h2>
|
|
<a id="a27b9c64d94494836c28e2fb78e01dc60"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a27b9c64d94494836c28e2fb78e01dc60">◆ </a></span>parametermap</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef std::map<string, std::vector<string> > <a class="el" href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60">Mastodon::API::parametermap</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Used for passing parameters. </p>
|
|
<p>Example: </p><div class="fragment"><div class="line"><a class="code" href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60">parametermap</a> p =</div><div class="line">{</div><div class="line"> {<span class="stringliteral">"field1"</span>, { <span class="stringliteral">"value1"</span>, <span class="stringliteral">"value2"</span> } },</div><div class="line"> {<span class="stringliteral">"field2"</span>, { <span class="stringliteral">"value"</span> } }</div><div class="line">}</div></div><!-- fragment --><dl class="section since"><dt>Since</dt><dd>before 0.11.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Enumeration Documentation</h2>
|
|
<a id="a3b88e9c1ff8daee1e730c3f3de1e2853"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3b88e9c1ff8daee1e730c3f3de1e2853">◆ </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="classMastodon_1_1API.html#a3b88e9c1ff8daee1e730c3f3de1e2853">Mastodon::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>A list of all v1 <a class="el" href="classMastodon_1_1API.html" title="Class for the Mastodon API. ">API</a> calls. </p>
|
|
<p>The original <code>/</code> are substituted by <code>_</code>.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>before 0.11.0 </dd></dl>
|
|
<div class="fragment"><div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  {</div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  accounts_id,</div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span>  accounts_verify_credentials,</div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  accounts_id_followers,</div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span>  accounts_id_following,</div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  accounts_id_statuses,</div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  accounts_relationships,</div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span>  accounts_search,</div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  blocks,</div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span>  domain_blocks,</div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  endorsements,</div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span>  favourites,</div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span>  follow_requests,</div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span>  instance,</div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span>  custom_emojis,</div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span>  lists,</div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  accounts_id_lists,</div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span>  lists_id_accounts,</div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span>  lists_id,</div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span>  mutes,</div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span>  notifications,</div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span>  notifications_id,</div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span>  reports,</div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span>  search,</div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span>  statuses_id,</div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span>  statuses_id_context,</div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span>  statuses_id_card,</div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span>  statuses_id_reblogged_by,</div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span>  statuses_id_favourited_by,</div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span>  timelines_home,</div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span>  timelines_public,</div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span>  timelines_tag_hashtag,</div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span>  timelines_list_list_id,</div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span>  <span class="comment">// PATCH</span></div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span>  accounts_update_credentials,</div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span>  <span class="comment">// POST</span></div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span>  accounts_id_follow,</div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span>  accounts_id_unfollow,</div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span>  accounts_id_block,</div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span>  accounts_id_unblock,</div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span>  accounts_id_mute,</div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span>  accounts_id_unmute,</div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span>  accounts_id_pin,</div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span>  accounts_id_unpin,</div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span>  apps,</div><div class="line"><a name="l00244"></a><span class="lineno"> 244</span>  follow_requests_id_authorize,</div><div class="line"><a name="l00245"></a><span class="lineno"> 245</span>  follow_requests_id_reject,</div><div class="line"><a name="l00246"></a><span class="lineno"> 246</span>  follows,</div><div class="line"><a name="l00247"></a><span class="lineno"> 247</span>  media,</div><div class="line"><a name="l00248"></a><span class="lineno"> 248</span>  notifications_clear,</div><div class="line"><a name="l00249"></a><span class="lineno"> 249</span>  notifications_dismiss,</div><div class="line"><a name="l00250"></a><span class="lineno"> 250</span>  statuses,</div><div class="line"><a name="l00251"></a><span class="lineno"> 251</span>  statuses_id_reblog,</div><div class="line"><a name="l00252"></a><span class="lineno"> 252</span>  statuses_id_unreblog,</div><div class="line"><a name="l00253"></a><span class="lineno"> 253</span>  statuses_id_favourite,</div><div class="line"><a name="l00254"></a><span class="lineno"> 254</span>  statuses_id_unfavourite,</div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span>  statuses_id_pin,</div><div class="line"><a name="l00256"></a><span class="lineno"> 256</span>  statuses_id_unpin,</div><div class="line"><a name="l00257"></a><span class="lineno"> 257</span>  statuses_id_mute,</div><div class="line"><a name="l00258"></a><span class="lineno"> 258</span>  statuses_id_unmute,</div><div class="line"><a name="l00259"></a><span class="lineno"> 259</span>  <span class="comment">// PUT</span></div><div class="line"><a name="l00260"></a><span class="lineno"> 260</span>  media_id,</div><div class="line"><a name="l00261"></a><span class="lineno"> 261</span>  <span class="comment">// Streaming</span></div><div class="line"><a name="l00262"></a><span class="lineno"> 262</span>  streaming_user,</div><div class="line"><a name="l00263"></a><span class="lineno"> 263</span>  streaming_public,</div><div class="line"><a name="l00264"></a><span class="lineno"> 264</span>  streaming_public_local,</div><div class="line"><a name="l00265"></a><span class="lineno"> 265</span>  streaming_hashtag,</div><div class="line"><a name="l00266"></a><span class="lineno"> 266</span>  streaming_list,</div><div class="line"><a name="l00267"></a><span class="lineno"> 267</span>  <span class="comment">// Push</span></div><div class="line"><a name="l00268"></a><span class="lineno"> 268</span>  push_subscription,</div><div class="line"><a name="l00269"></a><span class="lineno"> 269</span>  <span class="comment">// Glitch-Soc</span></div><div class="line"><a name="l00270"></a><span class="lineno"> 270</span>  bookmarks,</div><div class="line"><a name="l00271"></a><span class="lineno"> 271</span>  statuses_id_bookmark,</div><div class="line"><a name="l00272"></a><span class="lineno"> 272</span>  statuses_id_unbookmark</div><div class="line"><a name="l00273"></a><span class="lineno"> 273</span>  };</div></div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="aa9bb595d2e7632ab9aa37a9bb6836ed0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa9bb595d2e7632ab9aa37a9bb6836ed0">◆ </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="classMastodon_1_1API.html#aa9bb595d2e7632ab9aa37a9bb6836ed0">Mastodon::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>A list of all v2 <a class="el" href="classMastodon_1_1API.html" title="Class for the Mastodon API. ">API</a> calls. </p>
|
|
<p>The original <code>/</code> are substituted by <code>_</code>.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>0.16.0 </dd></dl>
|
|
<div class="fragment"><div class="line"><a name="l00283"></a><span class="lineno"> 283</span>  {</div><div class="line"><a name="l00284"></a><span class="lineno"> 284</span>  search</div><div class="line"><a name="l00285"></a><span class="lineno"> 285</span>  };</div></div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a627a687d2f211d714d2e1d2bd3faf7ff"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a627a687d2f211d714d2e1d2bd3faf7ff">◆ </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">API::API </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const string & </td>
|
|
<td class="paramname"><em>instance</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const string & </td>
|
|
<td class="paramname"><em>access_token</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</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 a new <a class="el" href="classMastodon_1_1API.html" title="Class for the Mastodon API. ">API</a> object. </p>
|
|
<p>To register your application, leave access_token blank and call <a class="el" href="classMastodon_1_1API.html#aa86264a4f70537a3278f17f7fabaad0a" title="Register application, step 1/2. ">register_app1()</a> and <a class="el" href="classMastodon_1_1API.html#a98c5052e9c0ebae2dbc5a24e3a4066e2" title="Register application, step 2/2. ">register_app2()</a>.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">instance</td><td>The hostname of your instance </td></tr>
|
|
<tr><td class="paramname">access_token</td><td>Your access token.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section since"><dt>Since</dt><dd>before 0.11.0 </dd></dl>
|
|
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="example10_simplify_8cpp-example.html#a1">example10_simplify.cpp</a>.</dd>
|
|
</dl><div class="fragment"><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> : _instance(instance)</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> , _access_token(access_token)</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> , _useragent(<span class="keywordtype">string</span>(<span class="stringliteral">"mastodon-cpp/"</span>) + global::version)</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> , _http(*<span class="keyword">this</span>, instance, access_token)</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> , _exceptions(<span class="keyword">false</span>)</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> , _proxy(<span class="stringliteral">""</span>)</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> , _proxy_userpw(<span class="stringliteral">""</span>)</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> {</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="comment">//</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> }</div></div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a507e4dc3769b58d05d272da25fb251d6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a507e4dc3769b58d05d272da25fb251d6">◆ </a></span>del() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint_fast16_t API::del </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classMastodon_1_1API.html#a3b88e9c1ff8daee1e730c3f3de1e2853">Mastodon::API::v1</a> & </td>
|
|
<td class="paramname"><em>call</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60">parametermap</a> & </td>
|
|
<td class="paramname"><em>parameters</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Make a DELETE request which requires parameters. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">call</td><td>A call defined in <a class="el" href="classMastodon_1_1API.html#a3b88e9c1ff8daee1e730c3f3de1e2853" title="A list of all v1 API calls. ">Mastodon::API::v1</a> </td></tr>
|
|
<tr><td class="paramname">parameters</td><td>A <a class="el" href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60" title="Used for passing parameters. ">Mastodon::API::parametermap</a> containing parameters</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classMastodon_1_1API.html#error">Error code</a>.</dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>before 0.11.0 </dd></dl>
|
|
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="example06_toot_delete-toot_8cpp-example.html#a3">example06_toot_delete-toot.cpp</a>.</dd>
|
|
</dl><div class="fragment"><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> {</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="keywordtype">string</span> strcall = <span class="stringliteral">""</span>;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="keywordtype">string</span> strid = <span class="stringliteral">""</span>;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="comment">// The ID is part of the path</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keyword">const</span> <span class="keyword">auto</span> &it = parameters.find(<span class="stringliteral">"id"</span>);</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keywordflow">if</span> (it != parameters.end())</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  strid = it->second[0];</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  }</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keywordflow">switch</span> (call)</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  {</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordflow">case</span> v1::domain_blocks:</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  strcall = <span class="stringliteral">"/api/v1/domain_blocks"</span>;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordflow">case</span> v1::lists_id:</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  strcall = <span class="stringliteral">"/api/v1/lists/"</span> + strid;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keywordflow">case</span> v1::lists_id_accounts:</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  strcall = <span class="stringliteral">"/api/v1/lists/"</span> + strid + <span class="stringliteral">"/accounts"</span>;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordflow">case</span> v1::statuses_id:</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  strcall = <span class="stringliteral">"/api/v1/statuses/"</span> + strid;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordflow">case</span> v1::push_subscription:</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  strcall = <span class="stringliteral">"/api/v1/push/subscription"</span>;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordflow">default</span>:</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  ttdebug << <span class="stringliteral">"ERROR: Invalid call.\n"</span>;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordflow">return</span> 11;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  }</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordtype">string</span> answer;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordflow">return</span> <a class="code" href="classMastodon_1_1API.html#a507e4dc3769b58d05d272da25fb251d6">del</a>(strcall, parameters, answer);</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> }</div><div class="ttc" id="classMastodon_1_1API_html_a507e4dc3769b58d05d272da25fb251d6"><div class="ttname"><a href="classMastodon_1_1API.html#a507e4dc3769b58d05d272da25fb251d6">Mastodon::API::del</a></div><div class="ttdeci">uint_fast16_t del(const Mastodon::API::v1 &call, const parametermap &parameters)</div><div class="ttdoc">Make a DELETE request which requires parameters. </div><div class="ttdef"><b>Definition:</b> delete.cpp:23</div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a16e812a0dfcc25988c92fd9810423772"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a16e812a0dfcc25988c92fd9810423772">◆ </a></span>del() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint_fast16_t Mastodon::API::del </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const string & </td>
|
|
<td class="paramname"><em>call</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60">parametermap</a> & </td>
|
|
<td class="paramname"><em>parameters</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string & </td>
|
|
<td class="paramname"><em>answer</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Make a custom DELETE request. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">call</td><td>String in the form <code>/api/v1/example</code> </td></tr>
|
|
<tr><td class="paramname">parameters</td><td>A <a class="el" href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60" title="Used for passing parameters. ">Mastodon::API::parametermap</a> containing parameters </td></tr>
|
|
<tr><td class="paramname">answer</td><td>The answer from the server. Usually JSON. On error an empty string.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classMastodon_1_1API.html#error">Error code</a>. If the URL has permanently changed, 13 is returned and answer is set to the new URL.</dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>before 0.11.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4e8d254c512c2038323437a1be1641d7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4e8d254c512c2038323437a1be1641d7">◆ </a></span>exceptions()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool API::exceptions </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const bool & </td>
|
|
<td class="paramname"><em>value</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Turn exceptions on or off. Defaults to off. </p>
|
|
<p>This applies to exceptions from curlpp. curlpp::RuntimeError and curlpp::LogicError.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">value</td><td>true for on, false for off</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true if exceptions are turned on, false otherwise</dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>before 0.11.0 </dd></dl>
|
|
<div class="fragment"><div class="line"><a name="l00278"></a><span class="lineno"> 278</span> {</div><div class="line"><a name="l00279"></a><span class="lineno"> 279</span>  _exceptions = value;</div><div class="line"><a name="l00280"></a><span class="lineno"> 280</span>  <span class="keywordflow">return</span> _exceptions;</div><div class="line"><a name="l00281"></a><span class="lineno"> 281</span> }</div></div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="ae42bb8841ebead64dbb555cb6284784e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae42bb8841ebead64dbb555cb6284784e">◆ </a></span>get() <span class="overload">[1/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint_fast16_t API::get </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classMastodon_1_1API.html#a3b88e9c1ff8daee1e730c3f3de1e2853">Mastodon::API::v1</a> & </td>
|
|
<td class="paramname"><em>call</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string & </td>
|
|
<td class="paramname"><em>answer</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Make a GET request which doesn't require parameters. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">call</td><td>A call defined in <a class="el" href="classMastodon_1_1API.html#a3b88e9c1ff8daee1e730c3f3de1e2853" title="A list of all v1 API calls. ">Mastodon::API::v1</a> </td></tr>
|
|
<tr><td class="paramname">answer</td><td>The answer from the server. Usually JSON. On error an empty string.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classMastodon_1_1API.html#error">Error code</a>.</dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>before 0.11.0 </dd></dl>
|
|
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="example01_dump_json_8cpp-example.html#a2">example01_dump_json.cpp</a>, <a class="el" href="example02_parse_account_8cpp-example.html#a1">example02_parse_account.cpp</a>, <a class="el" href="example03_mastocron_8cpp-example.html#a1">example03_mastocron.cpp</a>, <a class="el" href="example07_register_app_8cpp-example.html#a4">example07_register_app.cpp</a>, <a class="el" href="example08_rate_limiting_8cpp-example.html#a2">example08_rate_limiting.cpp</a>, and <a class="el" href="example15_proxy_8cpp-example.html#a2">example15_proxy.cpp</a>.</dd>
|
|
</dl><div class="fragment"><div class="line"><a name="l00208"></a><span class="lineno"> 208</span> {</div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  <span class="keyword">const</span> <a class="code" href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60">parametermap</a> p;</div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span>  <span class="keywordflow">return</span> <span class="keyword">get</span>(call, p, answer);</div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span> }</div><div class="ttc" id="classMastodon_1_1API_html_a27b9c64d94494836c28e2fb78e01dc60"><div class="ttname"><a href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60">Mastodon::API::parametermap</a></div><div class="ttdeci">std::map< string, std::vector< string > > parametermap</div><div class="ttdoc">Used for passing parameters. </div><div class="ttdef"><b>Definition:</b> mastodon-cpp.hpp:189</div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="ad428d084640d4d1c0b59ed5f358b5d78"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad428d084640d4d1c0b59ed5f358b5d78">◆ </a></span>get() <span class="overload">[2/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint_fast16_t API::get </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classMastodon_1_1API.html#a3b88e9c1ff8daee1e730c3f3de1e2853">Mastodon::API::v1</a> & </td>
|
|
<td class="paramname"><em>call</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60">parametermap</a> & </td>
|
|
<td class="paramname"><em>parameters</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string & </td>
|
|
<td class="paramname"><em>answer</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Make a GET request which requires parameters. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">call</td><td>A call defined in <a class="el" href="classMastodon_1_1API.html#a3b88e9c1ff8daee1e730c3f3de1e2853" title="A list of all v1 API calls. ">Mastodon::API::v1</a> </td></tr>
|
|
<tr><td class="paramname">parameters</td><td>A <a class="el" href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60" title="Used for passing parameters. ">Mastodon::API::parametermap</a> containing parameters </td></tr>
|
|
<tr><td class="paramname">answer</td><td>The answer from the server. Usually JSON. On error an empty string.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classMastodon_1_1API.html#error">Error code</a>. If the URL has permanently changed, 13 is returned and answer is set to the new URL. </dd></dl>
|
|
<div class="fragment"><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> {</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="keywordtype">string</span> strcall = <span class="stringliteral">""</span>;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="keywordtype">string</span> strid = <span class="stringliteral">""</span>;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="comment">// The ID is part of the path</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keyword">const</span> <span class="keyword">auto</span> &it = parameters.find(<span class="stringliteral">"id"</span>);</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keywordflow">if</span> (it != parameters.end())</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  {</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  strid = it->second[0];</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  }</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keywordflow">switch</span> (call)</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  {</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordflow">case</span> v1::accounts_verify_credentials:</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  strcall = <span class="stringliteral">"/api/v1/accounts/verify_credentials"</span>;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordflow">case</span> v1::blocks:</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  strcall = <span class="stringliteral">"/api/v1/blocks"</span>;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keywordflow">case</span> v1::domain_blocks:</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  strcall = <span class="stringliteral">"/api/v1/domain_blocks"</span>;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordflow">case</span> v1::favourites:</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  strcall = <span class="stringliteral">"/api/v1/favourites"</span>;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordflow">case</span> v1::follow_requests:</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  strcall = <span class="stringliteral">"/api/v1/follow_requests"</span>;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordflow">case</span> v1::instance:</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  strcall = <span class="stringliteral">"/api/v1/instance"</span>;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordflow">case</span> v1::custom_emojis:</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  strcall = <span class="stringliteral">"/api/v1/custom_emojis"</span>;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordflow">case</span> v1::lists:</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  strcall = <span class="stringliteral">"/api/v1/lists"</span>;</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordflow">case</span> v1::mutes:</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  strcall = <span class="stringliteral">"/api/v1/mutes"</span>;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordflow">case</span> v1::notifications:</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  strcall = <span class="stringliteral">"/api/v1/notifications"</span>;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordflow">case</span> v1::reports:</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  strcall = <span class="stringliteral">"/api/v1/reports"</span>;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordflow">case</span> v1::timelines_home:</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  strcall = <span class="stringliteral">"/api/v1/timelines/home"</span>;</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordflow">case</span> v1::timelines_public:</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  strcall = <span class="stringliteral">"/api/v1/timelines/public"</span>;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordflow">case</span> v1::accounts_relationships:</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  strcall = <span class="stringliteral">"/api/v1/accounts/relationships"</span>;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordflow">case</span> v1::accounts_id:</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  strcall = <span class="stringliteral">"/api/v1/accounts/"</span> + strid;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordflow">case</span> v1::accounts_id_followers:</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  strcall = <span class="stringliteral">"/api/v1/accounts/"</span> + strid + <span class="stringliteral">"/followers"</span>;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordflow">case</span> v1::accounts_id_following:</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  strcall = <span class="stringliteral">"/api/v1/accounts/"</span> + strid + <span class="stringliteral">"/following"</span>;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordflow">case</span> v1::accounts_id_statuses:</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  strcall = <span class="stringliteral">"/api/v1/accounts/"</span> + strid + <span class="stringliteral">"/statuses"</span>;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keywordflow">case</span> v1::accounts_search:</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  strcall = <span class="stringliteral">"/api/v1/accounts/search"</span>;</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordflow">case</span> v1::accounts_id_lists:</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  strcall = <span class="stringliteral">"/api/v1/accounts/"</span> + strid + <span class="stringliteral">"/lists"</span>;</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keywordflow">case</span> v1::lists_id_accounts:</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  strcall = <span class="stringliteral">"/api/v1/lists/"</span> + strid + <span class="stringliteral">"/accounts"</span>;</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keywordflow">case</span> v1::lists_id:</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  strcall = <span class="stringliteral">"/api/v1/lists/"</span> + strid;</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keywordflow">case</span> v1::notifications_id:</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  strcall = <span class="stringliteral">"/api/v1/notifications/"</span> + strid;</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="keywordflow">case</span> v1::search:</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  strcall = <span class="stringliteral">"/api/v1/search"</span>;</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keywordflow">case</span> v1::statuses_id:</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  strcall = <span class="stringliteral">"/api/v1/statuses/"</span> + strid;</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="keywordflow">case</span> v1::statuses_id_context:</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  strcall = <span class="stringliteral">"/api/v1/statuses/"</span> + strid + <span class="stringliteral">"/context"</span>;</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keywordflow">case</span> v1::statuses_id_card:</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  strcall = <span class="stringliteral">"/api/v1/statuses/"</span> + strid + <span class="stringliteral">"/card"</span>;</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keywordflow">case</span> v1::statuses_id_reblogged_by:</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  strcall = <span class="stringliteral">"/api/v1/statuses/"</span> + strid + <span class="stringliteral">"/reblogged_by"</span>;</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="keywordflow">case</span> v1::statuses_id_favourited_by:</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  strcall = <span class="stringliteral">"/api/v1/statuses/"</span> + strid + <span class="stringliteral">"/favourited_by"</span>;</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keywordflow">case</span> v1::timelines_tag_hashtag:</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  {</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="comment">// The hashtag is part of the path</span></div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <span class="keyword">const</span> <span class="keyword">auto</span> &it = parameters.find(<span class="stringliteral">"hashtag"</span>);</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  <span class="keywordflow">if</span> (it != parameters.end())</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  {</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  strcall = <span class="stringliteral">"/api/v1/timelines/tag/"</span> + <a class="code" href="classMastodon_1_1API.html#a41e36cb4a94140e68084a85b959fa30b">urlencode</a>(it->second[0]);</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  }</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <span class="keywordflow">else</span></div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  {</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  ttdebug << <span class="stringliteral">"ERROR: Invalid call.\n"</span>;</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="keywordflow">return</span> 11;</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>  }</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <span class="keywordflow">case</span> v1::timelines_list_list_id:</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  strcall = <span class="stringliteral">"/api/v1/timelines/list/"</span> + strid;</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <span class="keywordflow">case</span> v1::push_subscription:</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  strcall = <span class="stringliteral">"/api/v1/push/subscription"</span>;</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  <span class="keywordflow">case</span> v1::endorsements:</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  strcall = <span class="stringliteral">"/api/v1/endorsements"</span>;</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  <span class="keywordflow">case</span> v1::bookmarks:</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  strcall = <span class="stringliteral">"/api/v1/bookmarks"</span>;</div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <span class="keywordflow">default</span>:</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  ttdebug << <span class="stringliteral">"ERROR: Invalid call.\n"</span>;</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  <span class="keywordflow">return</span> 11;</div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  }</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>  <span class="keywordflow">if</span> (parameters.size() > 0)</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>  <span class="comment">// Delete the parameters that are already in strcall</span></div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  <a class="code" href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60">parametermap</a> newparameters = parameters;</div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  newparameters.erase(<span class="stringliteral">"id"</span>);</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  newparameters.erase(<span class="stringliteral">"hashtag"</span>);</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  strcall += maptostr(newparameters);</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> </div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  <span class="keywordflow">return</span> <span class="keyword">get</span>(strcall, answer);</div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> }</div><div class="ttc" id="classMastodon_1_1API_html_a41e36cb4a94140e68084a85b959fa30b"><div class="ttname"><a href="classMastodon_1_1API.html#a41e36cb4a94140e68084a85b959fa30b">Mastodon::API::urlencode</a></div><div class="ttdeci">static const string urlencode(const string &str)</div><div class="ttdoc">Percent-encodes a string. This is done automatically, unless you make a custom request. </div><div class="ttdef"><b>Definition:</b> mastodon-cpp.cpp:141</div></div>
|
|
<div class="ttc" id="classMastodon_1_1API_html_a27b9c64d94494836c28e2fb78e01dc60"><div class="ttname"><a href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60">Mastodon::API::parametermap</a></div><div class="ttdeci">std::map< string, std::vector< string > > parametermap</div><div class="ttdoc">Used for passing parameters. </div><div class="ttdef"><b>Definition:</b> mastodon-cpp.hpp:189</div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a7247207e69dfdec12d6153c0b7763cac"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7247207e69dfdec12d6153c0b7763cac">◆ </a></span>get() <span class="overload">[3/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint_fast16_t API::get </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classMastodon_1_1API.html#aa9bb595d2e7632ab9aa37a9bb6836ed0">Mastodon::API::v2</a> & </td>
|
|
<td class="paramname"><em>call</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60">parametermap</a> & </td>
|
|
<td class="paramname"><em>parameters</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string & </td>
|
|
<td class="paramname"><em>answer</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Make a GET request which requires parameters. </p>
|
|
<dl class="section since"><dt>Since</dt><dd>0.16.0 </dd></dl>
|
|
<div class="fragment"><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> {</div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  <span class="keywordtype">string</span> strcall = <span class="stringliteral">""</span>;</div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  <span class="keywordtype">string</span> strid = <span class="stringliteral">""</span>;</div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> </div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span>  <span class="comment">// The ID is part of the path</span></div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  <span class="keyword">const</span> <span class="keyword">auto</span> &it = parameters.find(<span class="stringliteral">"id"</span>);</div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  <span class="keywordflow">if</span> (it != parameters.end())</div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  {</div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  strid = it->second[0];</div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  }</div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span> </div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  <span class="keywordflow">switch</span> (call)</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>  <span class="keywordflow">case</span> v2::search:</div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  strcall = <span class="stringliteral">"/api/v2/search"</span>;</div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  <span class="keywordflow">default</span>:</div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span>  ttdebug << <span class="stringliteral">"ERROR: Invalid call.\n"</span>;</div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span>  <span class="keywordflow">return</span> 11;</div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span>  }</div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span> </div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  <span class="keywordflow">if</span> (parameters.size() > 0)</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  {</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  <span class="comment">// Delete the parameters that are already in strcall</span></div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  <a class="code" href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60">parametermap</a> newparameters = parameters;</div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  newparameters.erase(<span class="stringliteral">"id"</span>);</div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  newparameters.erase(<span class="stringliteral">"hashtag"</span>);</div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span>  strcall += maptostr(newparameters);</div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  }</div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span> </div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  <span class="keywordflow">return</span> <span class="keyword">get</span>(strcall, answer);</div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span> }</div><div class="ttc" id="classMastodon_1_1API_html_a27b9c64d94494836c28e2fb78e01dc60"><div class="ttname"><a href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60">Mastodon::API::parametermap</a></div><div class="ttdeci">std::map< string, std::vector< string > > parametermap</div><div class="ttdoc">Used for passing parameters. </div><div class="ttdef"><b>Definition:</b> mastodon-cpp.hpp:189</div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="abbeae53e9ee2402de9f7a38db16d2096"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abbeae53e9ee2402de9f7a38db16d2096">◆ </a></span>get() <span class="overload">[4/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint_fast16_t Mastodon::API::get </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const string & </td>
|
|
<td class="paramname"><em>call</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string & </td>
|
|
<td class="paramname"><em>answer</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Make a custom GET request. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">call</td><td>String in the form <code>/api/v1/example</code> </td></tr>
|
|
<tr><td class="paramname">answer</td><td>The answer from the server. Usually JSON. On error an empty string.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classMastodon_1_1API.html#error">Error code</a>. If the URL has permanently changed, 13 is returned and answer is set to the new URL.</dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>before 0.11.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad7392af31cff2a6b446aea1e6b58cbaf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad7392af31cff2a6b446aea1e6b58cbaf">◆ </a></span>get_header()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const string API::get_header </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const string & </td>
|
|
<td class="paramname"><em>header</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the header from the last answer. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">header</td><td>The header to get</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The header, or "" on error.</dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>before 0.11.0 </dd></dl>
|
|
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="example08_rate_limiting_8cpp-example.html#a3">example08_rate_limiting.cpp</a>.</dd>
|
|
</dl><div class="fragment"><div class="line"><a name="l00263"></a><span class="lineno"> 263</span> {</div><div class="line"><a name="l00264"></a><span class="lineno"> 264</span>  <span class="keywordtype">string</span> headers;</div><div class="line"><a name="l00265"></a><span class="lineno"> 265</span>  _http.<a class="code" href="classMastodon_1_1API_1_1http.html#afc0e6357f12dd6e35a48aefb098ffc4a">get_headers</a>(headers);</div><div class="line"><a name="l00266"></a><span class="lineno"> 266</span>  <span class="keywordtype">size_t</span> startpos = headers.find(header + <span class="charliteral">':'</span>);</div><div class="line"><a name="l00267"></a><span class="lineno"> 267</span>  <span class="keywordflow">if</span> (startpos != std::string::npos)</div><div class="line"><a name="l00268"></a><span class="lineno"> 268</span>  {</div><div class="line"><a name="l00269"></a><span class="lineno"> 269</span>  startpos = headers.find(<span class="charliteral">':'</span>, startpos) + 2;</div><div class="line"><a name="l00270"></a><span class="lineno"> 270</span>  <span class="keywordtype">size_t</span> endpos = headers.find(<span class="stringliteral">"\r\n"</span>, startpos);</div><div class="line"><a name="l00271"></a><span class="lineno"> 271</span>  <span class="keywordflow">return</span> headers.substr(startpos, endpos - startpos);</div><div class="line"><a name="l00272"></a><span class="lineno"> 272</span>  }</div><div class="line"><a name="l00273"></a><span class="lineno"> 273</span> </div><div class="line"><a name="l00274"></a><span class="lineno"> 274</span>  <span class="keywordflow">return</span> <span class="stringliteral">""</span>;</div><div class="line"><a name="l00275"></a><span class="lineno"> 275</span> }</div><div class="ttc" id="classMastodon_1_1API_1_1http_html_afc0e6357f12dd6e35a48aefb098ffc4a"><div class="ttname"><a href="classMastodon_1_1API_1_1http.html#afc0e6357f12dd6e35a48aefb098ffc4a">Mastodon::API::http::get_headers</a></div><div class="ttdeci">void get_headers(string &headers) const</div><div class="ttdoc">Get all headers in a string. </div><div class="ttdef"><b>Definition:</b> http.cpp:199</div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a06ad0990a9c21f20fbd2e17f03d1f75b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a06ad0990a9c21f20fbd2e17f03d1f75b">◆ </a></span>get_instance()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const string API::get_instance </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the instance. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The instance.</dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>before 0.11.0 </dd></dl>
|
|
<div class="fragment"><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> {</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordflow">return</span> _instance;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> }</div></div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="acc672d3637568d39ba9248ab39094b9f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acc672d3637568d39ba9248ab39094b9f">◆ </a></span>get_proxy()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void API::get_proxy </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string & </td>
|
|
<td class="paramname"><em>proxy</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string & </td>
|
|
<td class="paramname"><em>userpw</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>For internal use. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">proxy</td><td>URL </td></tr>
|
|
<tr><td class="paramname">userpw</td><td>username:password</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section since"><dt>Since</dt><dd>0.15.1 </dd></dl>
|
|
<div class="fragment"><div class="line"><a name="l00596"></a><span class="lineno"> 596</span> {</div><div class="line"><a name="l00597"></a><span class="lineno"> 597</span>  <span class="keywordflow">if</span> (!_proxy.empty())</div><div class="line"><a name="l00598"></a><span class="lineno"> 598</span>  {</div><div class="line"><a name="l00599"></a><span class="lineno"> 599</span>  proxy = _proxy;</div><div class="line"><a name="l00600"></a><span class="lineno"> 600</span>  <span class="keywordflow">if</span> (!_proxy_userpw.empty())</div><div class="line"><a name="l00601"></a><span class="lineno"> 601</span>  {</div><div class="line"><a name="l00602"></a><span class="lineno"> 602</span>  userpw = _proxy_userpw;</div><div class="line"><a name="l00603"></a><span class="lineno"> 603</span>  }</div><div class="line"><a name="l00604"></a><span class="lineno"> 604</span>  }</div><div class="line"><a name="l00605"></a><span class="lineno"> 605</span> }</div></div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a3f4df7ecf727cfcc4b9c20a18d0dbb34"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3f4df7ecf727cfcc4b9c20a18d0dbb34">◆ </a></span>get_stream() <span class="overload">[1/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint_fast16_t API::get_stream </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classMastodon_1_1API.html#a3b88e9c1ff8daee1e730c3f3de1e2853">Mastodon::API::v1</a> & </td>
|
|
<td class="paramname"><em>call</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60">parametermap</a> & </td>
|
|
<td class="paramname"><em>parameters</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string & </td>
|
|
<td class="paramname"><em>answer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::unique_ptr< <a class="el" href="classMastodon_1_1API_1_1http.html">Mastodon::API::http</a> > & </td>
|
|
<td class="paramname"><em>ptr</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Make a streaming GET request. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">call</td><td>A call defined in <a class="el" href="classMastodon_1_1API.html#a3b88e9c1ff8daee1e730c3f3de1e2853" title="A list of all v1 API calls. ">Mastodon::API::v1</a> </td></tr>
|
|
<tr><td class="paramname">parameters</td><td>A <a class="el" href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60" title="Used for passing parameters. ">Mastodon::API::parametermap</a> containing parameters </td></tr>
|
|
<tr><td class="paramname">answer</td><td>The answer from the server. Events with JSON-payload. </td></tr>
|
|
<tr><td class="paramname">ptr</td><td>Pointer to the http object. Can be used to call ptr->cancel_stream()</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classMastodon_1_1API.html#error">Error code</a>. If the URL has permanently changed, 13 is returned and answer is set to the new URL.</dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>before 0.11.0 </dd></dl>
|
|
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="example09_streaming_api_8cpp-example.html#a2">example09_streaming_api.cpp</a>.</dd>
|
|
</dl><div class="fragment"><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> {</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keywordtype">string</span> strcall = <span class="stringliteral">""</span>;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keywordflow">switch</span> (call)</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keywordflow">case</span> v1::streaming_user:</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  strcall = <span class="stringliteral">"/api/v1/streaming/user"</span>;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keywordflow">case</span> v1::streaming_public:</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  strcall = <span class="stringliteral">"/api/v1/streaming/public"</span>;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordflow">case</span> v1::streaming_public_local:</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  strcall = <span class="stringliteral">"/api/v1/streaming/public/local"</span>;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordflow">case</span> v1::streaming_hashtag:</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  strcall = <span class="stringliteral">"/api/v1/streaming/hashtag"</span>;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keywordflow">case</span> v1::streaming_list:</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  strcall = <span class="stringliteral">"/api/v1/streaming/list"</span>;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordflow">default</span>:</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  ttdebug << <span class="stringliteral">"ERROR: Invalid call.\n"</span>;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordflow">return</span> 11;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  }</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordflow">if</span> (parameters.size() > 0)</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  {</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  strcall += maptostr(parameters);</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  }</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordflow">return</span> <a class="code" href="classMastodon_1_1API.html#a3f4df7ecf727cfcc4b9c20a18d0dbb34">get_stream</a>(strcall, answer, ptr);</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> }</div><div class="ttc" id="classMastodon_1_1API_html_a3f4df7ecf727cfcc4b9c20a18d0dbb34"><div class="ttname"><a href="classMastodon_1_1API.html#a3f4df7ecf727cfcc4b9c20a18d0dbb34">Mastodon::API::get_stream</a></div><div class="ttdeci">uint_fast16_t get_stream(const Mastodon::API::v1 &call, const parametermap &parameters, string &answer, std::unique_ptr< Mastodon::API::http > &ptr)</div><div class="ttdoc">Make a streaming GET request. </div><div class="ttdef"><b>Definition:</b> get_stream.cpp:24</div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a1d72b3777918283e31a61447dce3ce7a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1d72b3777918283e31a61447dce3ce7a">◆ </a></span>get_stream() <span class="overload">[2/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint_fast16_t API::get_stream </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classMastodon_1_1API.html#a3b88e9c1ff8daee1e730c3f3de1e2853">Mastodon::API::v1</a> & </td>
|
|
<td class="paramname"><em>call</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string & </td>
|
|
<td class="paramname"><em>answer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::unique_ptr< <a class="el" href="classMastodon_1_1API_1_1http.html">Mastodon::API::http</a> > & </td>
|
|
<td class="paramname"><em>ptr</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Make a streaming GET request. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">call</td><td>A call defined in <a class="el" href="classMastodon_1_1API.html#a3b88e9c1ff8daee1e730c3f3de1e2853" title="A list of all v1 API calls. ">Mastodon::API::v1</a> </td></tr>
|
|
<tr><td class="paramname">answer</td><td>The answer from the server. Events with JSON-payload. </td></tr>
|
|
<tr><td class="paramname">ptr</td><td>Pointer to the http object. Can be used to call ptr->cancel_stream()</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classMastodon_1_1API.html#error">Error code</a>. If the URL has permanently changed, 13 is returned and answer is set to the new URL.</dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>before 0.11.0 </dd></dl>
|
|
<div class="fragment"><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> {</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <a class="code" href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60">parametermap</a> p = {};</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordflow">return</span> <a class="code" href="classMastodon_1_1API.html#a3f4df7ecf727cfcc4b9c20a18d0dbb34">get_stream</a>(call, p, answer, ptr);</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> }</div><div class="ttc" id="classMastodon_1_1API_html_a3f4df7ecf727cfcc4b9c20a18d0dbb34"><div class="ttname"><a href="classMastodon_1_1API.html#a3f4df7ecf727cfcc4b9c20a18d0dbb34">Mastodon::API::get_stream</a></div><div class="ttdeci">uint_fast16_t get_stream(const Mastodon::API::v1 &call, const parametermap &parameters, string &answer, std::unique_ptr< Mastodon::API::http > &ptr)</div><div class="ttdoc">Make a streaming GET request. </div><div class="ttdef"><b>Definition:</b> get_stream.cpp:24</div></div>
|
|
<div class="ttc" id="classMastodon_1_1API_html_a27b9c64d94494836c28e2fb78e01dc60"><div class="ttname"><a href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60">Mastodon::API::parametermap</a></div><div class="ttdeci">std::map< string, std::vector< string > > parametermap</div><div class="ttdoc">Used for passing parameters. </div><div class="ttdef"><b>Definition:</b> mastodon-cpp.hpp:189</div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="af43a3254769976e1ad6056b99f57661c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af43a3254769976e1ad6056b99f57661c">◆ </a></span>get_stream() <span class="overload">[3/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint_fast16_t Mastodon::API::get_stream </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const string & </td>
|
|
<td class="paramname"><em>call</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string & </td>
|
|
<td class="paramname"><em>answer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::unique_ptr< <a class="el" href="classMastodon_1_1API_1_1http.html">Mastodon::API::http</a> > & </td>
|
|
<td class="paramname"><em>ptr</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Make a streaming GET request. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">call</td><td>String in the form <code>/api/v1/example</code> </td></tr>
|
|
<tr><td class="paramname">answer</td><td>The answer from the server. Usually JSON. On error an empty string. </td></tr>
|
|
<tr><td class="paramname">ptr</td><td>Pointer to the http object. Can be used to call ptr->cancel_stream()</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classMastodon_1_1API.html#error">Error code</a>. If the URL has permanently changed, 13 is returned and answer is set to the new URL.</dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>before 0.11.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad7f0c4bbdfff6ebb769e34624329a4d0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad7f0c4bbdfff6ebb769e34624329a4d0">◆ </a></span>get_useragent()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const string API::get_useragent </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the useragent. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The useragent.</dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>before 0.11.0 </dd></dl>
|
|
<div class="fragment"><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> {</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordflow">return</span> _useragent;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> }</div></div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a40c34f41d9a0c6b6cf83e8dbf826267f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a40c34f41d9a0c6b6cf83e8dbf826267f">◆ </a></span>patch()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint_fast16_t API::patch </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classMastodon_1_1API.html#a3b88e9c1ff8daee1e730c3f3de1e2853">Mastodon::API::v1</a> & </td>
|
|
<td class="paramname"><em>call</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60">parametermap</a> & </td>
|
|
<td class="paramname"><em>parameters</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string & </td>
|
|
<td class="paramname"><em>answer</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Make a PATCH request. </p>
|
|
<p>Binary data must be base64-encoded or a filename.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">call</td><td>A call defined in <a class="el" href="classMastodon_1_1API.html#a3b88e9c1ff8daee1e730c3f3de1e2853" title="A list of all v1 API calls. ">Mastodon::API::v1</a> </td></tr>
|
|
<tr><td class="paramname">parameters</td><td>A <a class="el" href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60" title="Used for passing parameters. ">Mastodon::API::parametermap</a> containing parameters </td></tr>
|
|
<tr><td class="paramname">answer</td><td>The answer from the server. Usually JSON. On error an empty string.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classMastodon_1_1API.html#error">Error code</a>. If the URL has permanently changed, 13 is returned and answer is set to the new URL.</dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>before 0.11.0 </dd></dl>
|
|
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="example04_update_credentials_8cpp-example.html#a2">example04_update_credentials.cpp</a>.</dd>
|
|
</dl><div class="fragment"><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> {</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="keywordtype">string</span> strcall = <span class="stringliteral">""</span>;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keywordflow">switch</span> (call)</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keywordflow">case</span> v1::accounts_update_credentials:</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  strcall = <span class="stringliteral">"/api/v1/accounts/update_credentials"</span>;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keywordflow">default</span>:</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  ttdebug << <span class="stringliteral">"ERROR: Invalid call.\n"</span>;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keywordflow">return</span> 11;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  }</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordflow">return</span> _http.request(API::http::method::PATCH,</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  strcall, maptoformdata(parameters), answer);</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> }</div></div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="aaf5ba9253c05c733bc6a7819fd7455cd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaf5ba9253c05c733bc6a7819fd7455cd">◆ </a></span>post() <span class="overload">[1/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint_fast16_t API::post </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classMastodon_1_1API.html#a3b88e9c1ff8daee1e730c3f3de1e2853">Mastodon::API::v1</a> & </td>
|
|
<td class="paramname"><em>call</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string & </td>
|
|
<td class="paramname"><em>answer</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Make a POST request which doesn't require parameters. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">call</td><td>A call defined in <a class="el" href="classMastodon_1_1API.html#a3b88e9c1ff8daee1e730c3f3de1e2853" title="A list of all v1 API calls. ">Mastodon::API::v1</a> </td></tr>
|
|
<tr><td class="paramname">answer</td><td>The answer from the server. Usually JSON. On error an empty string.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classMastodon_1_1API.html#error">Error code</a>. If the URL has permanently changed, 13 is returned and answer is set to the new URL.</dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>before 0.11.0 </dd></dl>
|
|
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="example05_follow_unfollow_8cpp-example.html#a2">example05_follow_unfollow.cpp</a>, <a class="el" href="example06_toot_delete-toot_8cpp-example.html#a2">example06_toot_delete-toot.cpp</a>, <a class="el" href="example10_simplify_8cpp-example.html#a2">example10_simplify.cpp</a>, and <a class="el" href="example11_post_media_8cpp-example.html#a1">example11_post_media.cpp</a>.</dd>
|
|
</dl><div class="fragment"><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> {</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <span class="keyword">const</span> <a class="code" href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60">parametermap</a> p;</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="keywordflow">return</span> <a class="code" href="classMastodon_1_1API.html#aaf5ba9253c05c733bc6a7819fd7455cd">post</a>(call, p, answer);</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> }</div><div class="ttc" id="classMastodon_1_1API_html_aaf5ba9253c05c733bc6a7819fd7455cd"><div class="ttname"><a href="classMastodon_1_1API.html#aaf5ba9253c05c733bc6a7819fd7455cd">Mastodon::API::post</a></div><div class="ttdeci">uint_fast16_t post(const Mastodon::API::v1 &call, string &answer)</div><div class="ttdoc">Make a POST request which doesn&#39;t require parameters. </div><div class="ttdef"><b>Definition:</b> post.cpp:140</div></div>
|
|
<div class="ttc" id="classMastodon_1_1API_html_a27b9c64d94494836c28e2fb78e01dc60"><div class="ttname"><a href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60">Mastodon::API::parametermap</a></div><div class="ttdeci">std::map< string, std::vector< string > > parametermap</div><div class="ttdoc">Used for passing parameters. </div><div class="ttdef"><b>Definition:</b> mastodon-cpp.hpp:189</div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="adab19f56aac3129bbe7b59e4d33600e8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adab19f56aac3129bbe7b59e4d33600e8">◆ </a></span>post() <span class="overload">[2/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint_fast16_t API::post </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classMastodon_1_1API.html#a3b88e9c1ff8daee1e730c3f3de1e2853">Mastodon::API::v1</a> & </td>
|
|
<td class="paramname"><em>call</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60">parametermap</a> & </td>
|
|
<td class="paramname"><em>parameters</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string & </td>
|
|
<td class="paramname"><em>answer</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Make a POST request which requires parameters. </p>
|
|
<p>Binary data must be base64-encoded or a filename.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">call</td><td>A call defined in <a class="el" href="classMastodon_1_1API.html#a3b88e9c1ff8daee1e730c3f3de1e2853" title="A list of all v1 API calls. ">Mastodon::API::v1</a> </td></tr>
|
|
<tr><td class="paramname">parameters</td><td>A <a class="el" href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60" title="Used for passing parameters. ">Mastodon::API::parametermap</a> containing parameters </td></tr>
|
|
<tr><td class="paramname">answer</td><td>The answer from the server. Usually JSON. On error an empty string.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classMastodon_1_1API.html#error">Error code</a>. If the URL has permanently changed, 13 is returned and answer is set to the new URL.</dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>before 0.11.0 </dd></dl>
|
|
<div class="fragment"><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> {</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="keywordtype">string</span> strcall = <span class="stringliteral">""</span>;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="keywordtype">string</span> strid = <span class="stringliteral">""</span>;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="comment">// The ID is part of the path</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keyword">const</span> <span class="keyword">auto</span> &it = parameters.find(<span class="stringliteral">"id"</span>);</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keywordflow">if</span> (it != parameters.end())</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  strid = it->second[0];</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  }</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keywordflow">switch</span> (call)</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  {</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordflow">case</span> v1::apps:</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  strcall = <span class="stringliteral">"/api/v1/apps"</span>;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordflow">case</span> v1::domain_blocks:</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  strcall = <span class="stringliteral">"/api/v1/domain_blocks"</span>;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keywordflow">case</span> v1::follows:</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  strcall = <span class="stringliteral">"/api/v1/follows"</span>;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordflow">case</span> v1::lists:</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  strcall = <span class="stringliteral">"/api/v1/lists"</span>;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordflow">case</span> v1::media:</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  strcall = <span class="stringliteral">"/api/v1/media"</span>;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordflow">case</span> v1::notifications_clear:</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  strcall = <span class="stringliteral">"/api/v1/notifications/clear"</span>;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordflow">case</span> v1::notifications_dismiss:</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  strcall = <span class="stringliteral">"/api/v1/notifications/dismiss"</span>;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordflow">case</span> v1::reports:</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  strcall = <span class="stringliteral">"/api/v1/reports"</span>;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordflow">case</span> v1::statuses:</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  strcall = <span class="stringliteral">"/api/v1/statuses"</span>;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordflow">case</span> v1::accounts_id_follow:</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  strcall = <span class="stringliteral">"/api/v1/accounts/"</span> + strid + <span class="stringliteral">"/follow"</span>;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordflow">case</span> v1::accounts_id_unfollow:</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  strcall = <span class="stringliteral">"/api/v1/accounts/"</span> + strid + <span class="stringliteral">"/unfollow"</span>;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordflow">case</span> v1::accounts_id_block:</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  strcall = <span class="stringliteral">"/api/v1/accounts/"</span> + strid + <span class="stringliteral">"/block"</span>;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordflow">case</span> v1::accounts_id_unblock:</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  strcall = <span class="stringliteral">"/api/v1/accounts/"</span> + strid + <span class="stringliteral">"/unblock"</span>;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordflow">case</span> v1::accounts_id_mute:</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  strcall = <span class="stringliteral">"/api/v1/accounts/"</span> + strid + <span class="stringliteral">"/mute"</span>;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordflow">case</span> v1::accounts_id_unmute:</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  strcall = <span class="stringliteral">"/api/v1/accounts/"</span> + strid + <span class="stringliteral">"/unmute"</span>;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordflow">case</span> v1::follow_requests_id_authorize:</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  strcall = <span class="stringliteral">"/api/v1/folow_requests/"</span> + strid + <span class="stringliteral">"/authorize"</span>;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordflow">case</span> v1::follow_requests_id_reject:</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  strcall = <span class="stringliteral">"/api/v1/folow_requests/"</span> + strid + <span class="stringliteral">"/reject"</span>;</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordflow">case</span> v1::lists_id_accounts:</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  strcall = <span class="stringliteral">"/api/v1/lists/"</span> + strid + <span class="stringliteral">"/accounts"</span>;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keywordflow">case</span> v1::statuses_id_reblog:</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  strcall = <span class="stringliteral">"/api/v1/statuses/"</span> + strid + <span class="stringliteral">"/reblog"</span>;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordflow">case</span> v1::statuses_id_unreblog:</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  strcall = <span class="stringliteral">"/api/v1/statuses/"</span> + strid + <span class="stringliteral">"/unreblog"</span>;</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keywordflow">case</span> v1::statuses_id_favourite:</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  strcall = <span class="stringliteral">"/api/v1/statuses/"</span> + strid + <span class="stringliteral">"/favourite"</span>;</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keywordflow">case</span> v1::statuses_id_unfavourite:</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  strcall = <span class="stringliteral">"/api/v1/statuses/"</span> + strid + <span class="stringliteral">"/unfavourite"</span>;</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keywordflow">case</span> v1::statuses_id_pin:</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  strcall = <span class="stringliteral">"/api/v1/statuses/"</span> + strid + <span class="stringliteral">"/pin"</span>;</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="keywordflow">case</span> v1::statuses_id_unpin:</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  strcall = <span class="stringliteral">"/api/v1/statuses/"</span> + strid + <span class="stringliteral">"/unpin"</span>;</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keywordflow">case</span> v1::statuses_id_mute:</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  strcall = <span class="stringliteral">"/api/v1/statuses/"</span> + strid + <span class="stringliteral">"/mute"</span>;</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keywordflow">case</span> v1::statuses_id_unmute:</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  strcall = <span class="stringliteral">"/api/v1/statuses/"</span> + strid + <span class="stringliteral">"/unmute"</span>;</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keywordflow">case</span> v1::push_subscription:</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  strcall = <span class="stringliteral">"/api/v1/push/subscription"</span>;</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keywordflow">case</span> v1::accounts_id_pin:</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  strcall = <span class="stringliteral">"/api/v1/accounts/"</span> + strid + <span class="stringliteral">"/pin"</span>;</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keywordflow">case</span> v1::accounts_id_unpin:</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  strcall = <span class="stringliteral">"/api/v1/accounts/"</span> + strid + <span class="stringliteral">"/unpin"</span>;</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="keywordflow">case</span> v1::statuses_id_bookmark:</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  strcall = <span class="stringliteral">"/api/v1/statuses/"</span> + strid + <span class="stringliteral">"/bookmark"</span>;</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="keywordflow">case</span> v1::statuses_id_unbookmark:</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  strcall = <span class="stringliteral">"/api/v1/statuses/"</span> + strid + <span class="stringliteral">"/unbookmark"</span>;</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="keywordflow">default</span>:</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  ttdebug << <span class="stringliteral">"ERROR: Invalid call.\n"</span>;</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <span class="keywordflow">return</span> 11;</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  }</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> </div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="keywordflow">return</span> <a class="code" href="classMastodon_1_1API.html#aaf5ba9253c05c733bc6a7819fd7455cd">post</a>(strcall, parameters, answer);</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> }</div><div class="ttc" id="classMastodon_1_1API_html_aaf5ba9253c05c733bc6a7819fd7455cd"><div class="ttname"><a href="classMastodon_1_1API.html#aaf5ba9253c05c733bc6a7819fd7455cd">Mastodon::API::post</a></div><div class="ttdeci">uint_fast16_t post(const Mastodon::API::v1 &call, string &answer)</div><div class="ttdoc">Make a POST request which doesn&#39;t require parameters. </div><div class="ttdef"><b>Definition:</b> post.cpp:140</div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="aa9d6bd66adab80d9eca9c345e08c4dc8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa9d6bd66adab80d9eca9c345e08c4dc8">◆ </a></span>post() <span class="overload">[3/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint_fast16_t API::post </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const string & </td>
|
|
<td class="paramname"><em>call</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60">parametermap</a> & </td>
|
|
<td class="paramname"><em>parameters</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string & </td>
|
|
<td class="paramname"><em>answer</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Make a custom POST request. </p>
|
|
<p>Binary data must be base64-encoded or a filename.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">call</td><td>String in the form <code>/api/v1/example</code> </td></tr>
|
|
<tr><td class="paramname">parameters</td><td>A <a class="el" href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60" title="Used for passing parameters. ">Mastodon::API::parametermap</a> containing parameters </td></tr>
|
|
<tr><td class="paramname">answer</td><td>The answer from the server. Usually JSON. On error an empty string.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classMastodon_1_1API.html#error">Error code</a>. If the URL has permanently changed, 13 is returned and answer is set to the new URL.</dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>before 0.11.0 </dd></dl>
|
|
<div class="fragment"><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> {</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> </div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  <span class="keywordflow">return</span> _http.request(http::method::POST, call,</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  maptoformdata(parameters), answer);</div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> }</div></div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="abe648cccdc9645206564d3f5615e5056"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abe648cccdc9645206564d3f5615e5056">◆ </a></span>put() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint_fast16_t API::put </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classMastodon_1_1API.html#a3b88e9c1ff8daee1e730c3f3de1e2853">Mastodon::API::v1</a> & </td>
|
|
<td class="paramname"><em>call</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60">parametermap</a> & </td>
|
|
<td class="paramname"><em>parameters</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string & </td>
|
|
<td class="paramname"><em>answer</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Make a PUT request which requires a parameters. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">call</td><td>A call defined in <a class="el" href="classMastodon_1_1API.html#a3b88e9c1ff8daee1e730c3f3de1e2853" title="A list of all v1 API calls. ">Mastodon::API::v1</a> </td></tr>
|
|
<tr><td class="paramname">parameters</td><td>A <a class="el" href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60" title="Used for passing parameters. ">Mastodon::API::parametermap</a> containing parameters </td></tr>
|
|
<tr><td class="paramname">answer</td><td>The answer from the server. Usually JSON. On error an empty string.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classMastodon_1_1API.html#error">Error code</a>. If the URL has permanently changed, 13 is returned and answer is set to the new URL.</dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>before 0.11.0 </dd></dl>
|
|
<div class="fragment"><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> {</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="keywordtype">string</span> strcall = <span class="stringliteral">""</span>;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="keywordtype">string</span> strid = <span class="stringliteral">""</span>;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="comment">// The ID is part of the path</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keyword">const</span> <span class="keyword">auto</span> &it = parameters.find(<span class="stringliteral">"id"</span>);</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keywordflow">if</span> (it != parameters.end())</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  strid = it->second[0];</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  }</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keywordflow">switch</span> (call)</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  {</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordflow">case</span> v1::lists_id:</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  strcall = <span class="stringliteral">"/api/v1/lists/"</span> + strid;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordflow">case</span> v1::media_id:</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  strcall = <span class="stringliteral">"/api/v1/media/"</span> + strid;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keywordflow">case</span> v1::push_subscription:</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  strcall = <span class="stringliteral">"/api/v1/push/subscription"</span>;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordflow">default</span>:</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  ttdebug << <span class="stringliteral">"ERROR: Invalid call.\n"</span>;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordflow">return</span> 11;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordflow">break</span>;</div><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> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordflow">return</span> <a class="code" href="classMastodon_1_1API.html#abe648cccdc9645206564d3f5615e5056">put</a>(strcall, parameters, answer);</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> }</div><div class="ttc" id="classMastodon_1_1API_html_abe648cccdc9645206564d3f5615e5056"><div class="ttname"><a href="classMastodon_1_1API.html#abe648cccdc9645206564d3f5615e5056">Mastodon::API::put</a></div><div class="ttdeci">uint_fast16_t put(const Mastodon::API::v1 &call, const parametermap &parameters, string &answer)</div><div class="ttdoc">Make a PUT request which requires a parameters. </div><div class="ttdef"><b>Definition:</b> put.cpp:23</div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a1f1503b9b84ac34e1a4d0793d28db532"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1f1503b9b84ac34e1a4d0793d28db532">◆ </a></span>put() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint_fast16_t API::put </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const string & </td>
|
|
<td class="paramname"><em>call</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60">parametermap</a> & </td>
|
|
<td class="paramname"><em>parameters</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string & </td>
|
|
<td class="paramname"><em>answer</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Make a custom PUT request. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">call</td><td>String in the form <code>/api/v1/example</code> </td></tr>
|
|
<tr><td class="paramname">parameters</td><td>A <a class="el" href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60" title="Used for passing parameters. ">Mastodon::API::parametermap</a> containing parameters </td></tr>
|
|
<tr><td class="paramname">answer</td><td>The answer from the server. Usually JSON. On error an empty string.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classMastodon_1_1API.html#error">Error code</a>. If the URL has permanently changed, 13 is returned and answer is set to the new URL.</dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>before 0.11.0 </dd></dl>
|
|
<div class="fragment"><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> {</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordflow">return</span> _http.request(http::method::PUT, call,</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  maptoformdata(parameters), answer);</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> }</div></div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="aa86264a4f70537a3278f17f7fabaad0a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa86264a4f70537a3278f17f7fabaad0a">◆ </a></span>register_app1()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint_fast16_t API::register_app1 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const string & </td>
|
|
<td class="paramname"><em>client_name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const string & </td>
|
|
<td class="paramname"><em>redirect_uri</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const string & </td>
|
|
<td class="paramname"><em>scopes</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const string & </td>
|
|
<td class="paramname"><em>website</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string & </td>
|
|
<td class="paramname"><em>client_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string & </td>
|
|
<td class="paramname"><em>client_secret</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string & </td>
|
|
<td class="paramname"><em>url</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Register application, step 1/2. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">client_name</td><td>The name of the application </td></tr>
|
|
<tr><td class="paramname">redirect_uri</td><td>urn:ietf:wg:oauth:2.0:oob for none </td></tr>
|
|
<tr><td class="paramname">scopes</td><td>Scopes (<code>read</code>, <code>write</code>, <code>follow</code>, <code>push</code>; space separated) </td></tr>
|
|
<tr><td class="paramname">website</td><td>The website of the application </td></tr>
|
|
<tr><td class="paramname">client_id</td><td>Returned </td></tr>
|
|
<tr><td class="paramname">client_secret</td><td>Returned </td></tr>
|
|
<tr><td class="paramname">url</td><td>Returned, used to generate code for register_app2</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classMastodon_1_1API.html#error">Error code</a>. If the URL has permanently changed, 13 is returned and url is set to the new URL.</dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>before 0.11.0 </dd></dl>
|
|
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="example07_register_app_8cpp-example.html#a2">example07_register_app.cpp</a>.</dd>
|
|
</dl><div class="fragment"><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>  <a class="code" href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60">API::parametermap</a> parameters =</div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  {</div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  { <span class="stringliteral">"client_name"</span>, { client_name } },</div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  { <span class="stringliteral">"redirect_uris"</span>, { redirect_uri } },</div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  { <span class="stringliteral">"scopes"</span>, { scopes } },</div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  { <span class="stringliteral">"website"</span>, { website } }</div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span>  };</div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span> </div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  <span class="keywordtype">string</span> answer;</div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  uint_fast16_t ret = <a class="code" href="classMastodon_1_1API.html#aaf5ba9253c05c733bc6a7819fd7455cd">post</a>(API::v1::apps, parameters, answer);</div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span> </div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  <span class="keywordflow">if</span> (ret == 0)</div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  {</div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  std::smatch match;</div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  std::regex reid(<span class="stringliteral">"client_id\":\"([0-9a-fA-F]+)\""</span>);</div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  std::regex resecret(<span class="stringliteral">"client_secret\":\"([0-9a-fA-F]+)\""</span>);</div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> </div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  std::regex_search(answer, match, reid);</div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  client_id = match[1].str();</div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span>  std::regex_search(answer, match, resecret);</div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span>  client_secret = match[1].str();</div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span> </div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span>  url = <span class="stringliteral">"https://"</span> + _instance + <span class="stringliteral">"/oauth/authorize"</span> +</div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  <span class="stringliteral">"?scope="</span> + <a class="code" href="classMastodon_1_1API.html#a41e36cb4a94140e68084a85b959fa30b">urlencode</a>(scopes) + <span class="stringliteral">"&response_type=code"</span> +</div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  <span class="stringliteral">"&redirect_uri="</span> + <a class="code" href="classMastodon_1_1API.html#a41e36cb4a94140e68084a85b959fa30b">urlencode</a>(redirect_uri) +</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  <span class="stringliteral">"&client_id="</span> + client_id;</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  <span class="keywordflow">if</span> (!website.empty())</div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  {</div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  url += <span class="stringliteral">"&website="</span> + <a class="code" href="classMastodon_1_1API.html#a41e36cb4a94140e68084a85b959fa30b">urlencode</a>(website);</div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  }</div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span> </div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  <span class="keywordflow">return</span> 0;</div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span>  }</div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  <span class="keywordflow">else</span> <span class="keywordflow">if</span> (ret == 13)</div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  {</div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span>  url = answer;</div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  <span class="keywordflow">return</span> ret;</div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span>  }</div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  <span class="keywordflow">else</span></div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span>  {</div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span>  std::cerr << <span class="stringliteral">"Error code: "</span> << ret << <span class="charliteral">'\n'</span>;</div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span>  <span class="keywordflow">return</span> ret;</div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span>  }</div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span>  </div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span> }</div><div class="ttc" id="classMastodon_1_1API_html_a41e36cb4a94140e68084a85b959fa30b"><div class="ttname"><a href="classMastodon_1_1API.html#a41e36cb4a94140e68084a85b959fa30b">Mastodon::API::urlencode</a></div><div class="ttdeci">static const string urlencode(const string &str)</div><div class="ttdoc">Percent-encodes a string. This is done automatically, unless you make a custom request. </div><div class="ttdef"><b>Definition:</b> mastodon-cpp.cpp:141</div></div>
|
|
<div class="ttc" id="classMastodon_1_1API_html_aaf5ba9253c05c733bc6a7819fd7455cd"><div class="ttname"><a href="classMastodon_1_1API.html#aaf5ba9253c05c733bc6a7819fd7455cd">Mastodon::API::post</a></div><div class="ttdeci">uint_fast16_t post(const Mastodon::API::v1 &call, string &answer)</div><div class="ttdoc">Make a POST request which doesn&#39;t require parameters. </div><div class="ttdef"><b>Definition:</b> post.cpp:140</div></div>
|
|
<div class="ttc" id="classMastodon_1_1API_html_a27b9c64d94494836c28e2fb78e01dc60"><div class="ttname"><a href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60">Mastodon::API::parametermap</a></div><div class="ttdeci">std::map< string, std::vector< string > > parametermap</div><div class="ttdoc">Used for passing parameters. </div><div class="ttdef"><b>Definition:</b> mastodon-cpp.hpp:189</div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a98c5052e9c0ebae2dbc5a24e3a4066e2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a98c5052e9c0ebae2dbc5a24e3a4066e2">◆ </a></span>register_app2()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint_fast16_t API::register_app2 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const string & </td>
|
|
<td class="paramname"><em>client_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const string & </td>
|
|
<td class="paramname"><em>client_secret</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const string & </td>
|
|
<td class="paramname"><em>redirect_uri</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const string & </td>
|
|
<td class="paramname"><em>code</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string & </td>
|
|
<td class="paramname"><em>access_token</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Register application, step 2/2. </p>
|
|
<p>The access token will be used in all subsequent calls.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">client_id</td><td><br />
|
|
</td></tr>
|
|
<tr><td class="paramname">client_secret</td><td><br />
|
|
</td></tr>
|
|
<tr><td class="paramname">redirect_uri</td><td>urn:ietf:wg:oauth:2.0:oob for none </td></tr>
|
|
<tr><td class="paramname">code</td><td>The code generated by the website </td></tr>
|
|
<tr><td class="paramname">access_token</td><td>Returned</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classMastodon_1_1API.html#error">Error code</a>.</dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>before 0.11.0 </dd></dl>
|
|
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="example07_register_app_8cpp-example.html#a3">example07_register_app.cpp</a>.</dd>
|
|
</dl><div class="fragment"><div class="line"><a name="l00232"></a><span class="lineno"> 232</span> {</div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span>  <a class="code" href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60">API::parametermap</a> parameters =</div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span>  {</div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span>  { <span class="stringliteral">"client_id"</span>, { client_id } },</div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span>  { <span class="stringliteral">"client_secret"</span>, { client_secret } },</div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span>  { <span class="stringliteral">"grant_type"</span>, { <span class="stringliteral">"authorization_code"</span> } },</div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span>  { <span class="stringliteral">"redirect_uri"</span>, { redirect_uri } },</div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span>  { <span class="stringliteral">"code"</span>, { code } },</div><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> </div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span>  std::string answer;</div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span>  uint_fast16_t ret = <a class="code" href="classMastodon_1_1API.html#aaf5ba9253c05c733bc6a7819fd7455cd">post</a>(<span class="stringliteral">"/oauth/token"</span>, parameters, answer);</div><div class="line"><a name="l00244"></a><span class="lineno"> 244</span>  <span class="keywordflow">if</span> (ret == 0)</div><div class="line"><a name="l00245"></a><span class="lineno"> 245</span>  {</div><div class="line"><a name="l00246"></a><span class="lineno"> 246</span>  std::smatch match;</div><div class="line"><a name="l00247"></a><span class="lineno"> 247</span>  std::regex retoken(<span class="stringliteral">"access_token\":\"([0-9a-fA-F]+)\""</span>);</div><div class="line"><a name="l00248"></a><span class="lineno"> 248</span> </div><div class="line"><a name="l00249"></a><span class="lineno"> 249</span>  std::regex_search(answer, match, retoken);</div><div class="line"><a name="l00250"></a><span class="lineno"> 250</span>  access_token = match[1].str();</div><div class="line"><a name="l00251"></a><span class="lineno"> 251</span>  _access_token = access_token;</div><div class="line"><a name="l00252"></a><span class="lineno"> 252</span> </div><div class="line"><a name="l00253"></a><span class="lineno"> 253</span>  <span class="keywordflow">return</span> 0;</div><div class="line"><a name="l00254"></a><span class="lineno"> 254</span>  }</div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span>  <span class="keywordflow">else</span></div><div class="line"><a name="l00256"></a><span class="lineno"> 256</span>  {</div><div class="line"><a name="l00257"></a><span class="lineno"> 257</span>  std::cerr << <span class="stringliteral">"Error code: "</span> << ret << <span class="charliteral">'\n'</span>;</div><div class="line"><a name="l00258"></a><span class="lineno"> 258</span>  <span class="keywordflow">return</span> ret;</div><div class="line"><a name="l00259"></a><span class="lineno"> 259</span>  }</div><div class="line"><a name="l00260"></a><span class="lineno"> 260</span> }</div><div class="ttc" id="classMastodon_1_1API_html_aaf5ba9253c05c733bc6a7819fd7455cd"><div class="ttname"><a href="classMastodon_1_1API.html#aaf5ba9253c05c733bc6a7819fd7455cd">Mastodon::API::post</a></div><div class="ttdeci">uint_fast16_t post(const Mastodon::API::v1 &call, string &answer)</div><div class="ttdoc">Make a POST request which doesn&#39;t require parameters. </div><div class="ttdef"><b>Definition:</b> post.cpp:140</div></div>
|
|
<div class="ttc" id="classMastodon_1_1API_html_a27b9c64d94494836c28e2fb78e01dc60"><div class="ttname"><a href="classMastodon_1_1API.html#a27b9c64d94494836c28e2fb78e01dc60">Mastodon::API::parametermap</a></div><div class="ttdeci">std::map< string, std::vector< string > > parametermap</div><div class="ttdoc">Used for passing parameters. </div><div class="ttdef"><b>Definition:</b> mastodon-cpp.hpp:189</div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a980009607243247a1295468a7adcd43c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a980009607243247a1295468a7adcd43c">◆ </a></span>set_proxy()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void API::set_proxy </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const string & </td>
|
|
<td class="paramname"><em>proxy</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const string & </td>
|
|
<td class="paramname"><em>userpw</em> = <code>""</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the proxy. </p>
|
|
<p>Since mastodon-cpp is built on libcurl, it respects the same proxy environment variables. See <code>man curl</code>.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">proxy</td><td>See <code>man 3 CURLOPT_PROXY</code> </td></tr>
|
|
<tr><td class="paramname">userpw</td><td>See <code>man 3 CURLOPT_PROXYUSERPWD</code> (optional)</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section since"><dt>Since</dt><dd>0.15.0 </dd></dl>
|
|
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="example15_proxy_8cpp-example.html#a1">example15_proxy.cpp</a>.</dd>
|
|
</dl><div class="fragment"><div class="line"><a name="l00590"></a><span class="lineno"> 590</span> {</div><div class="line"><a name="l00591"></a><span class="lineno"> 591</span>  _proxy = proxy;</div><div class="line"><a name="l00592"></a><span class="lineno"> 592</span>  _proxy_userpw = userpw;</div><div class="line"><a name="l00593"></a><span class="lineno"> 593</span> }</div></div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="ae25c5e6eabb8e783d7034ee1c79ae741"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae25c5e6eabb8e783d7034ee1c79ae741">◆ </a></span>set_useragent()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void API::set_useragent </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const string & </td>
|
|
<td class="paramname"><em>useragent</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the useragent. Default is mastodon-cpp/version. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">useragent</td><td>The useragent</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section since"><dt>Since</dt><dd>before 0.11.0 </dd></dl>
|
|
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="example01_dump_json_8cpp-example.html#a1">example01_dump_json.cpp</a>, <a class="el" href="example04_update_credentials_8cpp-example.html#a1">example04_update_credentials.cpp</a>, <a class="el" href="example05_follow_unfollow_8cpp-example.html#a1">example05_follow_unfollow.cpp</a>, <a class="el" href="example06_toot_delete-toot_8cpp-example.html#a1">example06_toot_delete-toot.cpp</a>, <a class="el" href="example07_register_app_8cpp-example.html#a1">example07_register_app.cpp</a>, <a class="el" href="example08_rate_limiting_8cpp-example.html#a1">example08_rate_limiting.cpp</a>, and <a class="el" href="example09_streaming_api_8cpp-example.html#a1">example09_streaming_api.cpp</a>.</dd>
|
|
</dl><div class="fragment"><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> {</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  _useragent = useragent;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> }</div></div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a52ea24477c513aa211cf724be7a570f6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a52ea24477c513aa211cf724be7a570f6">◆ </a></span>unescape_html()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const string API::unescape_html </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const string & </td>
|
|
<td class="paramname"><em>html</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Replaces HTML entities with UTF-8 characters. </p>
|
|
<p>Supports named and numbered entities, decimal and hexadecimal.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>0.12.0 </dd></dl>
|
|
<div class="fragment"><div class="line"><a name="l00289"></a><span class="lineno"> 289</span> {</div><div class="line"><a name="l00290"></a><span class="lineno"> 290</span>  <span class="keywordtype">string</span> buffer = html;</div><div class="line"><a name="l00291"></a><span class="lineno"> 291</span>  <span class="keywordtype">string</span> output = <span class="stringliteral">""</span>;</div><div class="line"><a name="l00292"></a><span class="lineno"> 292</span> </div><div class="line"><a name="l00293"></a><span class="lineno"> 293</span>  <span class="comment">// Used to convert int to utf-8 char</span></div><div class="line"><a name="l00294"></a><span class="lineno"> 294</span>  std::wstring_convert<std::codecvt_utf8<char32_t>, char32_t> u8c;</div><div class="line"><a name="l00295"></a><span class="lineno"> 295</span>  <span class="comment">// Matches numbered entities between 1 and 8 digits, decimal or hexadecimal</span></div><div class="line"><a name="l00296"></a><span class="lineno"> 296</span>  std::regex re_entity(<span class="stringliteral">"&#(x)?(\\d{1,8});"</span>);</div><div class="line"><a name="l00297"></a><span class="lineno"> 297</span>  std::smatch match;</div><div class="line"><a name="l00298"></a><span class="lineno"> 298</span>  </div><div class="line"><a name="l00299"></a><span class="lineno"> 299</span>  <span class="keywordflow">while</span> (std::regex_search(buffer, match, re_entity))</div><div class="line"><a name="l00300"></a><span class="lineno"> 300</span>  {</div><div class="line"><a name="l00301"></a><span class="lineno"> 301</span>  char32_t codepoint = 0;</div><div class="line"><a name="l00302"></a><span class="lineno"> 302</span>  <span class="comment">// 'x' in front of the number means it's hexadecimal, else decimal.</span></div><div class="line"><a name="l00303"></a><span class="lineno"> 303</span>  <span class="keywordflow">if</span> (match[1].length() == 1)</div><div class="line"><a name="l00304"></a><span class="lineno"> 304</span>  {</div><div class="line"><a name="l00305"></a><span class="lineno"> 305</span>  codepoint = std::stoi(match[2].str(), <span class="keyword">nullptr</span>, 16);</div><div class="line"><a name="l00306"></a><span class="lineno"> 306</span>  }</div><div class="line"><a name="l00307"></a><span class="lineno"> 307</span>  <span class="keywordflow">else</span></div><div class="line"><a name="l00308"></a><span class="lineno"> 308</span>  {</div><div class="line"><a name="l00309"></a><span class="lineno"> 309</span>  codepoint = std::stoi(match[2].str(), <span class="keyword">nullptr</span>, 10);</div><div class="line"><a name="l00310"></a><span class="lineno"> 310</span>  }</div><div class="line"><a name="l00311"></a><span class="lineno"> 311</span>  output += match.prefix().str() + u8c.to_bytes(codepoint);</div><div class="line"><a name="l00312"></a><span class="lineno"> 312</span>  buffer = match.suffix().str();</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>  output += buffer;</div><div class="line"><a name="l00315"></a><span class="lineno"> 315</span> </div><div class="line"><a name="l00316"></a><span class="lineno"> 316</span>  <span class="comment">// Source: https://en.wikipedia.org/wiki/List_of_XML_and_HTML_character_</span></div><div class="line"><a name="l00317"></a><span class="lineno"> 317</span>  <span class="comment">// entity_references#Character_entity_references_in_HTML</span></div><div class="line"><a name="l00318"></a><span class="lineno"> 318</span>  <span class="keyword">const</span> std::array<const std::pair<const string, const char32_t>, 258> names =</div><div class="line"><a name="l00319"></a><span class="lineno"> 319</span>  {{</div><div class="line"><a name="l00320"></a><span class="lineno"> 320</span>  { <span class="stringliteral">"exclamation"</span>, 0x0021 },</div><div class="line"><a name="l00321"></a><span class="lineno"> 321</span>  { <span class="stringliteral">"quot"</span>, 0x0022 },</div><div class="line"><a name="l00322"></a><span class="lineno"> 322</span>  { <span class="stringliteral">"percent"</span>, 0x0025 },</div><div class="line"><a name="l00323"></a><span class="lineno"> 323</span>  { <span class="stringliteral">"amp"</span>, 0x0026 },</div><div class="line"><a name="l00324"></a><span class="lineno"> 324</span>  { <span class="stringliteral">"apos"</span>, 0x0027 },</div><div class="line"><a name="l00325"></a><span class="lineno"> 325</span>  { <span class="stringliteral">"add"</span>, 0x002B },</div><div class="line"><a name="l00326"></a><span class="lineno"> 326</span>  { <span class="stringliteral">"lt"</span>, 0x003C },</div><div class="line"><a name="l00327"></a><span class="lineno"> 327</span>  { <span class="stringliteral">"equal"</span>, 0x003D },</div><div class="line"><a name="l00328"></a><span class="lineno"> 328</span>  { <span class="stringliteral">"gt"</span>, 0x003E },</div><div class="line"><a name="l00329"></a><span class="lineno"> 329</span>  { <span class="stringliteral">"nbsp"</span>, 0x00A0 },</div><div class="line"><a name="l00330"></a><span class="lineno"> 330</span>  { <span class="stringliteral">"iexcl"</span>, 0x00A1 },</div><div class="line"><a name="l00331"></a><span class="lineno"> 331</span>  { <span class="stringliteral">"cent"</span>, 0x00A2 },</div><div class="line"><a name="l00332"></a><span class="lineno"> 332</span>  { <span class="stringliteral">"pound"</span>, 0x00A3 },</div><div class="line"><a name="l00333"></a><span class="lineno"> 333</span>  { <span class="stringliteral">"curren"</span>, 0x00A4 },</div><div class="line"><a name="l00334"></a><span class="lineno"> 334</span>  { <span class="stringliteral">"yen"</span>, 0x00A5 },</div><div class="line"><a name="l00335"></a><span class="lineno"> 335</span>  { <span class="stringliteral">"brvbar"</span>, 0x00A6 },</div><div class="line"><a name="l00336"></a><span class="lineno"> 336</span>  { <span class="stringliteral">"sect"</span>, 0x00A7 },</div><div class="line"><a name="l00337"></a><span class="lineno"> 337</span>  { <span class="stringliteral">"uml"</span>, 0x00A8 },</div><div class="line"><a name="l00338"></a><span class="lineno"> 338</span>  { <span class="stringliteral">"copy"</span>, 0x00A9 },</div><div class="line"><a name="l00339"></a><span class="lineno"> 339</span>  { <span class="stringliteral">"ordf"</span>, 0x00AA },</div><div class="line"><a name="l00340"></a><span class="lineno"> 340</span>  { <span class="stringliteral">"laquo"</span>, 0x00AB },</div><div class="line"><a name="l00341"></a><span class="lineno"> 341</span>  { <span class="stringliteral">"not"</span>, 0x00AC },</div><div class="line"><a name="l00342"></a><span class="lineno"> 342</span>  { <span class="stringliteral">"shy"</span>, 0x00AD },</div><div class="line"><a name="l00343"></a><span class="lineno"> 343</span>  { <span class="stringliteral">"reg"</span>, 0x00AE },</div><div class="line"><a name="l00344"></a><span class="lineno"> 344</span>  { <span class="stringliteral">"macr"</span>, 0x00AF },</div><div class="line"><a name="l00345"></a><span class="lineno"> 345</span>  { <span class="stringliteral">"deg"</span>, 0x00B0 },</div><div class="line"><a name="l00346"></a><span class="lineno"> 346</span>  { <span class="stringliteral">"plusmn"</span>, 0x00B1 },</div><div class="line"><a name="l00347"></a><span class="lineno"> 347</span>  { <span class="stringliteral">"sup2"</span>, 0x00B2 },</div><div class="line"><a name="l00348"></a><span class="lineno"> 348</span>  { <span class="stringliteral">"sup3"</span>, 0x00B3 },</div><div class="line"><a name="l00349"></a><span class="lineno"> 349</span>  { <span class="stringliteral">"acute"</span>, 0x00B4 },</div><div class="line"><a name="l00350"></a><span class="lineno"> 350</span>  { <span class="stringliteral">"micro"</span>, 0x00B5 },</div><div class="line"><a name="l00351"></a><span class="lineno"> 351</span>  { <span class="stringliteral">"para"</span>, 0x00B6 },</div><div class="line"><a name="l00352"></a><span class="lineno"> 352</span>  { <span class="stringliteral">"middot"</span>, 0x00B7 },</div><div class="line"><a name="l00353"></a><span class="lineno"> 353</span>  { <span class="stringliteral">"cedil"</span>, 0x00B8 },</div><div class="line"><a name="l00354"></a><span class="lineno"> 354</span>  { <span class="stringliteral">"sup1"</span>, 0x00B9 },</div><div class="line"><a name="l00355"></a><span class="lineno"> 355</span>  { <span class="stringliteral">"ordm"</span>, 0x00BA },</div><div class="line"><a name="l00356"></a><span class="lineno"> 356</span>  { <span class="stringliteral">"raquo"</span>, 0x00BB },</div><div class="line"><a name="l00357"></a><span class="lineno"> 357</span>  { <span class="stringliteral">"frac14"</span>, 0x00BC },</div><div class="line"><a name="l00358"></a><span class="lineno"> 358</span>  { <span class="stringliteral">"frac12"</span>, 0x00BD },</div><div class="line"><a name="l00359"></a><span class="lineno"> 359</span>  { <span class="stringliteral">"frac34"</span>, 0x00BE },</div><div class="line"><a name="l00360"></a><span class="lineno"> 360</span>  { <span class="stringliteral">"iquest"</span>, 0x00BF },</div><div class="line"><a name="l00361"></a><span class="lineno"> 361</span>  { <span class="stringliteral">"Agrave"</span>, 0x00C0 },</div><div class="line"><a name="l00362"></a><span class="lineno"> 362</span>  { <span class="stringliteral">"Aacute"</span>, 0x00C1 },</div><div class="line"><a name="l00363"></a><span class="lineno"> 363</span>  { <span class="stringliteral">"Acirc"</span>, 0x00C2 },</div><div class="line"><a name="l00364"></a><span class="lineno"> 364</span>  { <span class="stringliteral">"Atilde"</span>, 0x00C3 },</div><div class="line"><a name="l00365"></a><span class="lineno"> 365</span>  { <span class="stringliteral">"Auml"</span>, 0x00C4 },</div><div class="line"><a name="l00366"></a><span class="lineno"> 366</span>  { <span class="stringliteral">"Aring"</span>, 0x00C5 },</div><div class="line"><a name="l00367"></a><span class="lineno"> 367</span>  { <span class="stringliteral">"AElig"</span>, 0x00C6 },</div><div class="line"><a name="l00368"></a><span class="lineno"> 368</span>  { <span class="stringliteral">"Ccedil"</span>, 0x00C7 },</div><div class="line"><a name="l00369"></a><span class="lineno"> 369</span>  { <span class="stringliteral">"Egrave"</span>, 0x00C8 },</div><div class="line"><a name="l00370"></a><span class="lineno"> 370</span>  { <span class="stringliteral">"Eacute"</span>, 0x00C9 },</div><div class="line"><a name="l00371"></a><span class="lineno"> 371</span>  { <span class="stringliteral">"Ecirc"</span>, 0x00CA },</div><div class="line"><a name="l00372"></a><span class="lineno"> 372</span>  { <span class="stringliteral">"Euml"</span>, 0x00CB },</div><div class="line"><a name="l00373"></a><span class="lineno"> 373</span>  { <span class="stringliteral">"Igrave"</span>, 0x00CC },</div><div class="line"><a name="l00374"></a><span class="lineno"> 374</span>  { <span class="stringliteral">"Iacute"</span>, 0x00CD },</div><div class="line"><a name="l00375"></a><span class="lineno"> 375</span>  { <span class="stringliteral">"Icirc"</span>, 0x00CE },</div><div class="line"><a name="l00376"></a><span class="lineno"> 376</span>  { <span class="stringliteral">"Iuml"</span>, 0x00CF },</div><div class="line"><a name="l00377"></a><span class="lineno"> 377</span>  { <span class="stringliteral">"ETH"</span>, 0x00D0 },</div><div class="line"><a name="l00378"></a><span class="lineno"> 378</span>  { <span class="stringliteral">"Ntilde"</span>, 0x00D1 },</div><div class="line"><a name="l00379"></a><span class="lineno"> 379</span>  { <span class="stringliteral">"Ograve"</span>, 0x00D2 },</div><div class="line"><a name="l00380"></a><span class="lineno"> 380</span>  { <span class="stringliteral">"Oacute"</span>, 0x00D3 },</div><div class="line"><a name="l00381"></a><span class="lineno"> 381</span>  { <span class="stringliteral">"Ocirc"</span>, 0x00D4 },</div><div class="line"><a name="l00382"></a><span class="lineno"> 382</span>  { <span class="stringliteral">"Otilde"</span>, 0x00D5 },</div><div class="line"><a name="l00383"></a><span class="lineno"> 383</span>  { <span class="stringliteral">"Ouml"</span>, 0x00D6 },</div><div class="line"><a name="l00384"></a><span class="lineno"> 384</span>  { <span class="stringliteral">"times"</span>, 0x00D7 },</div><div class="line"><a name="l00385"></a><span class="lineno"> 385</span>  { <span class="stringliteral">"Oslash"</span>, 0x00D8 },</div><div class="line"><a name="l00386"></a><span class="lineno"> 386</span>  { <span class="stringliteral">"Ugrave"</span>, 0x00D9 },</div><div class="line"><a name="l00387"></a><span class="lineno"> 387</span>  { <span class="stringliteral">"Uacute"</span>, 0x00DA },</div><div class="line"><a name="l00388"></a><span class="lineno"> 388</span>  { <span class="stringliteral">"Ucirc"</span>, 0x00DB },</div><div class="line"><a name="l00389"></a><span class="lineno"> 389</span>  { <span class="stringliteral">"Uuml"</span>, 0x00DC },</div><div class="line"><a name="l00390"></a><span class="lineno"> 390</span>  { <span class="stringliteral">"Yacute"</span>, 0x00DD },</div><div class="line"><a name="l00391"></a><span class="lineno"> 391</span>  { <span class="stringliteral">"THORN"</span>, 0x00DE },</div><div class="line"><a name="l00392"></a><span class="lineno"> 392</span>  { <span class="stringliteral">"szlig"</span>, 0x00DF },</div><div class="line"><a name="l00393"></a><span class="lineno"> 393</span>  { <span class="stringliteral">"agrave"</span>, 0x00E0 },</div><div class="line"><a name="l00394"></a><span class="lineno"> 394</span>  { <span class="stringliteral">"aacute"</span>, 0x00E1 },</div><div class="line"><a name="l00395"></a><span class="lineno"> 395</span>  { <span class="stringliteral">"acirc"</span>, 0x00E2 },</div><div class="line"><a name="l00396"></a><span class="lineno"> 396</span>  { <span class="stringliteral">"atilde"</span>, 0x00E3 },</div><div class="line"><a name="l00397"></a><span class="lineno"> 397</span>  { <span class="stringliteral">"auml"</span>, 0x00E4 },</div><div class="line"><a name="l00398"></a><span class="lineno"> 398</span>  { <span class="stringliteral">"aring"</span>, 0x00E5 },</div><div class="line"><a name="l00399"></a><span class="lineno"> 399</span>  { <span class="stringliteral">"aelig"</span>, 0x00E6 },</div><div class="line"><a name="l00400"></a><span class="lineno"> 400</span>  { <span class="stringliteral">"ccedil"</span>, 0x00E7 },</div><div class="line"><a name="l00401"></a><span class="lineno"> 401</span>  { <span class="stringliteral">"egrave"</span>, 0x00E8 },</div><div class="line"><a name="l00402"></a><span class="lineno"> 402</span>  { <span class="stringliteral">"eacute"</span>, 0x00E9 },</div><div class="line"><a name="l00403"></a><span class="lineno"> 403</span>  { <span class="stringliteral">"ecirc"</span>, 0x00EA },</div><div class="line"><a name="l00404"></a><span class="lineno"> 404</span>  { <span class="stringliteral">"euml"</span>, 0x00EB },</div><div class="line"><a name="l00405"></a><span class="lineno"> 405</span>  { <span class="stringliteral">"igrave"</span>, 0x00EC },</div><div class="line"><a name="l00406"></a><span class="lineno"> 406</span>  { <span class="stringliteral">"iacute"</span>, 0x00ED },</div><div class="line"><a name="l00407"></a><span class="lineno"> 407</span>  { <span class="stringliteral">"icirc"</span>, 0x00EE },</div><div class="line"><a name="l00408"></a><span class="lineno"> 408</span>  { <span class="stringliteral">"iuml"</span>, 0x00EF },</div><div class="line"><a name="l00409"></a><span class="lineno"> 409</span>  { <span class="stringliteral">"eth"</span>, 0x00F0 },</div><div class="line"><a name="l00410"></a><span class="lineno"> 410</span>  { <span class="stringliteral">"ntilde"</span>, 0x00F1 },</div><div class="line"><a name="l00411"></a><span class="lineno"> 411</span>  { <span class="stringliteral">"ograve"</span>, 0x00F2 },</div><div class="line"><a name="l00412"></a><span class="lineno"> 412</span>  { <span class="stringliteral">"oacute"</span>, 0x00F3 },</div><div class="line"><a name="l00413"></a><span class="lineno"> 413</span>  { <span class="stringliteral">"ocirc"</span>, 0x00F4 },</div><div class="line"><a name="l00414"></a><span class="lineno"> 414</span>  { <span class="stringliteral">"otilde"</span>, 0x00F5 },</div><div class="line"><a name="l00415"></a><span class="lineno"> 415</span>  { <span class="stringliteral">"ouml"</span>, 0x00F6 },</div><div class="line"><a name="l00416"></a><span class="lineno"> 416</span>  { <span class="stringliteral">"divide"</span>, 0x00F7 },</div><div class="line"><a name="l00417"></a><span class="lineno"> 417</span>  { <span class="stringliteral">"oslash"</span>, 0x00F8 },</div><div class="line"><a name="l00418"></a><span class="lineno"> 418</span>  { <span class="stringliteral">"ugrave"</span>, 0x00F9 },</div><div class="line"><a name="l00419"></a><span class="lineno"> 419</span>  { <span class="stringliteral">"uacute"</span>, 0x00FA },</div><div class="line"><a name="l00420"></a><span class="lineno"> 420</span>  { <span class="stringliteral">"ucirc"</span>, 0x00FB },</div><div class="line"><a name="l00421"></a><span class="lineno"> 421</span>  { <span class="stringliteral">"uuml"</span>, 0x00FC },</div><div class="line"><a name="l00422"></a><span class="lineno"> 422</span>  { <span class="stringliteral">"yacute"</span>, 0x00FD },</div><div class="line"><a name="l00423"></a><span class="lineno"> 423</span>  { <span class="stringliteral">"thorn"</span>, 0x00FE },</div><div class="line"><a name="l00424"></a><span class="lineno"> 424</span>  { <span class="stringliteral">"yuml"</span>, 0x00FF },</div><div class="line"><a name="l00425"></a><span class="lineno"> 425</span>  { <span class="stringliteral">"OElig"</span>, 0x0152 },</div><div class="line"><a name="l00426"></a><span class="lineno"> 426</span>  { <span class="stringliteral">"oelig"</span>, 0x0153 },</div><div class="line"><a name="l00427"></a><span class="lineno"> 427</span>  { <span class="stringliteral">"Scaron"</span>, 0x0160 },</div><div class="line"><a name="l00428"></a><span class="lineno"> 428</span>  { <span class="stringliteral">"scaron"</span>, 0x0161 },</div><div class="line"><a name="l00429"></a><span class="lineno"> 429</span>  { <span class="stringliteral">"Yuml"</span>, 0x0178 },</div><div class="line"><a name="l00430"></a><span class="lineno"> 430</span>  { <span class="stringliteral">"fnof"</span>, 0x0192 },</div><div class="line"><a name="l00431"></a><span class="lineno"> 431</span>  { <span class="stringliteral">"circ"</span>, 0x02C6 },</div><div class="line"><a name="l00432"></a><span class="lineno"> 432</span>  { <span class="stringliteral">"tilde"</span>, 0x02DC },</div><div class="line"><a name="l00433"></a><span class="lineno"> 433</span>  { <span class="stringliteral">"Alpha"</span>, 0x0391 },</div><div class="line"><a name="l00434"></a><span class="lineno"> 434</span>  { <span class="stringliteral">"Beta"</span>, 0x0392 },</div><div class="line"><a name="l00435"></a><span class="lineno"> 435</span>  { <span class="stringliteral">"Gamma"</span>, 0x0393 },</div><div class="line"><a name="l00436"></a><span class="lineno"> 436</span>  { <span class="stringliteral">"Delta"</span>, 0x0394 },</div><div class="line"><a name="l00437"></a><span class="lineno"> 437</span>  { <span class="stringliteral">"Epsilon"</span>, 0x0395 },</div><div class="line"><a name="l00438"></a><span class="lineno"> 438</span>  { <span class="stringliteral">"Zeta"</span>, 0x0396 },</div><div class="line"><a name="l00439"></a><span class="lineno"> 439</span>  { <span class="stringliteral">"Eta"</span>, 0x0397 },</div><div class="line"><a name="l00440"></a><span class="lineno"> 440</span>  { <span class="stringliteral">"Theta"</span>, 0x0398 },</div><div class="line"><a name="l00441"></a><span class="lineno"> 441</span>  { <span class="stringliteral">"Iota"</span>, 0x0399 },</div><div class="line"><a name="l00442"></a><span class="lineno"> 442</span>  { <span class="stringliteral">"Kappa"</span>, 0x039A },</div><div class="line"><a name="l00443"></a><span class="lineno"> 443</span>  { <span class="stringliteral">"Lambda"</span>, 0x039B },</div><div class="line"><a name="l00444"></a><span class="lineno"> 444</span>  { <span class="stringliteral">"Mu"</span>, 0x039C },</div><div class="line"><a name="l00445"></a><span class="lineno"> 445</span>  { <span class="stringliteral">"Nu"</span>, 0x039D },</div><div class="line"><a name="l00446"></a><span class="lineno"> 446</span>  { <span class="stringliteral">"Xi"</span>, 0x039E },</div><div class="line"><a name="l00447"></a><span class="lineno"> 447</span>  { <span class="stringliteral">"Omicron"</span>, 0x039F },</div><div class="line"><a name="l00448"></a><span class="lineno"> 448</span>  { <span class="stringliteral">"Pi"</span>, 0x03A0 },</div><div class="line"><a name="l00449"></a><span class="lineno"> 449</span>  { <span class="stringliteral">"Rho"</span>, 0x03A1 },</div><div class="line"><a name="l00450"></a><span class="lineno"> 450</span>  { <span class="stringliteral">"Sigma"</span>, 0x03A3 },</div><div class="line"><a name="l00451"></a><span class="lineno"> 451</span>  { <span class="stringliteral">"Tau"</span>, 0x03A4 },</div><div class="line"><a name="l00452"></a><span class="lineno"> 452</span>  { <span class="stringliteral">"Upsilon"</span>, 0x03A5 },</div><div class="line"><a name="l00453"></a><span class="lineno"> 453</span>  { <span class="stringliteral">"Phi"</span>, 0x03A6 },</div><div class="line"><a name="l00454"></a><span class="lineno"> 454</span>  { <span class="stringliteral">"Chi"</span>, 0x03A7 },</div><div class="line"><a name="l00455"></a><span class="lineno"> 455</span>  { <span class="stringliteral">"Psi"</span>, 0x03A8 },</div><div class="line"><a name="l00456"></a><span class="lineno"> 456</span>  { <span class="stringliteral">"Omega"</span>, 0x03A9 },</div><div class="line"><a name="l00457"></a><span class="lineno"> 457</span>  { <span class="stringliteral">"alpha"</span>, 0x03B1 },</div><div class="line"><a name="l00458"></a><span class="lineno"> 458</span>  { <span class="stringliteral">"beta"</span>, 0x03B2 },</div><div class="line"><a name="l00459"></a><span class="lineno"> 459</span>  { <span class="stringliteral">"gamma"</span>, 0x03B3 },</div><div class="line"><a name="l00460"></a><span class="lineno"> 460</span>  { <span class="stringliteral">"delta"</span>, 0x03B4 },</div><div class="line"><a name="l00461"></a><span class="lineno"> 461</span>  { <span class="stringliteral">"epsilon"</span>, 0x03B5 },</div><div class="line"><a name="l00462"></a><span class="lineno"> 462</span>  { <span class="stringliteral">"zeta"</span>, 0x03B6 },</div><div class="line"><a name="l00463"></a><span class="lineno"> 463</span>  { <span class="stringliteral">"eta"</span>, 0x03B7 },</div><div class="line"><a name="l00464"></a><span class="lineno"> 464</span>  { <span class="stringliteral">"theta"</span>, 0x03B8 },</div><div class="line"><a name="l00465"></a><span class="lineno"> 465</span>  { <span class="stringliteral">"iota"</span>, 0x03B9 },</div><div class="line"><a name="l00466"></a><span class="lineno"> 466</span>  { <span class="stringliteral">"kappa"</span>, 0x03BA },</div><div class="line"><a name="l00467"></a><span class="lineno"> 467</span>  { <span class="stringliteral">"lambda"</span>, 0x03BB },</div><div class="line"><a name="l00468"></a><span class="lineno"> 468</span>  { <span class="stringliteral">"mu"</span>, 0x03BC },</div><div class="line"><a name="l00469"></a><span class="lineno"> 469</span>  { <span class="stringliteral">"nu"</span>, 0x03BD },</div><div class="line"><a name="l00470"></a><span class="lineno"> 470</span>  { <span class="stringliteral">"xi"</span>, 0x03BE },</div><div class="line"><a name="l00471"></a><span class="lineno"> 471</span>  { <span class="stringliteral">"omicron"</span>, 0x03BF },</div><div class="line"><a name="l00472"></a><span class="lineno"> 472</span>  { <span class="stringliteral">"pi"</span>, 0x03C0 },</div><div class="line"><a name="l00473"></a><span class="lineno"> 473</span>  { <span class="stringliteral">"rho"</span>, 0x03C1 },</div><div class="line"><a name="l00474"></a><span class="lineno"> 474</span>  { <span class="stringliteral">"sigmaf"</span>, 0x03C2 },</div><div class="line"><a name="l00475"></a><span class="lineno"> 475</span>  { <span class="stringliteral">"sigma"</span>, 0x03C3 },</div><div class="line"><a name="l00476"></a><span class="lineno"> 476</span>  { <span class="stringliteral">"tau"</span>, 0x03C4 },</div><div class="line"><a name="l00477"></a><span class="lineno"> 477</span>  { <span class="stringliteral">"upsilon"</span>, 0x03C5 },</div><div class="line"><a name="l00478"></a><span class="lineno"> 478</span>  { <span class="stringliteral">"phi"</span>, 0x03C6 },</div><div class="line"><a name="l00479"></a><span class="lineno"> 479</span>  { <span class="stringliteral">"chi"</span>, 0x03C7 },</div><div class="line"><a name="l00480"></a><span class="lineno"> 480</span>  { <span class="stringliteral">"psi"</span>, 0x03C8 },</div><div class="line"><a name="l00481"></a><span class="lineno"> 481</span>  { <span class="stringliteral">"omega"</span>, 0x03C9 },</div><div class="line"><a name="l00482"></a><span class="lineno"> 482</span>  { <span class="stringliteral">"thetasym"</span>, 0x03D1 },</div><div class="line"><a name="l00483"></a><span class="lineno"> 483</span>  { <span class="stringliteral">"upsih"</span>, 0x03D2 },</div><div class="line"><a name="l00484"></a><span class="lineno"> 484</span>  { <span class="stringliteral">"piv"</span>, 0x03D6 },</div><div class="line"><a name="l00485"></a><span class="lineno"> 485</span>  { <span class="stringliteral">"ensp"</span>, 0x2002 },</div><div class="line"><a name="l00486"></a><span class="lineno"> 486</span>  { <span class="stringliteral">"emsp"</span>, 0x2003 },</div><div class="line"><a name="l00487"></a><span class="lineno"> 487</span>  { <span class="stringliteral">"thinsp"</span>, 0x2009 },</div><div class="line"><a name="l00488"></a><span class="lineno"> 488</span>  { <span class="stringliteral">"zwnj"</span>, 0x200C },</div><div class="line"><a name="l00489"></a><span class="lineno"> 489</span>  { <span class="stringliteral">"zwj"</span>, 0x200D },</div><div class="line"><a name="l00490"></a><span class="lineno"> 490</span>  { <span class="stringliteral">"lrm"</span>, 0x200E },</div><div class="line"><a name="l00491"></a><span class="lineno"> 491</span>  { <span class="stringliteral">"rlm"</span>, 0x200F },</div><div class="line"><a name="l00492"></a><span class="lineno"> 492</span>  { <span class="stringliteral">"ndash"</span>, 0x2013 },</div><div class="line"><a name="l00493"></a><span class="lineno"> 493</span>  { <span class="stringliteral">"mdash"</span>, 0x2014 },</div><div class="line"><a name="l00494"></a><span class="lineno"> 494</span>  { <span class="stringliteral">"horbar"</span>, 0x2015 },</div><div class="line"><a name="l00495"></a><span class="lineno"> 495</span>  { <span class="stringliteral">"lsquo"</span>, 0x2018 },</div><div class="line"><a name="l00496"></a><span class="lineno"> 496</span>  { <span class="stringliteral">"rsquo"</span>, 0x2019 },</div><div class="line"><a name="l00497"></a><span class="lineno"> 497</span>  { <span class="stringliteral">"sbquo"</span>, 0x201A },</div><div class="line"><a name="l00498"></a><span class="lineno"> 498</span>  { <span class="stringliteral">"ldquo"</span>, 0x201C },</div><div class="line"><a name="l00499"></a><span class="lineno"> 499</span>  { <span class="stringliteral">"rdquo"</span>, 0x201D },</div><div class="line"><a name="l00500"></a><span class="lineno"> 500</span>  { <span class="stringliteral">"bdquo"</span>, 0x201E },</div><div class="line"><a name="l00501"></a><span class="lineno"> 501</span>  { <span class="stringliteral">"dagger"</span>, 0x2020 },</div><div class="line"><a name="l00502"></a><span class="lineno"> 502</span>  { <span class="stringliteral">"Dagger"</span>, 0x2021 },</div><div class="line"><a name="l00503"></a><span class="lineno"> 503</span>  { <span class="stringliteral">"bull"</span>, 0x2022 },</div><div class="line"><a name="l00504"></a><span class="lineno"> 504</span>  { <span class="stringliteral">"hellip"</span>, 0x2026 },</div><div class="line"><a name="l00505"></a><span class="lineno"> 505</span>  { <span class="stringliteral">"permil"</span>, 0x2030 },</div><div class="line"><a name="l00506"></a><span class="lineno"> 506</span>  { <span class="stringliteral">"prime"</span>, 0x2032 },</div><div class="line"><a name="l00507"></a><span class="lineno"> 507</span>  { <span class="stringliteral">"Prime"</span>, 0x2033 },</div><div class="line"><a name="l00508"></a><span class="lineno"> 508</span>  { <span class="stringliteral">"lsaquo"</span>, 0x2039 },</div><div class="line"><a name="l00509"></a><span class="lineno"> 509</span>  { <span class="stringliteral">"rsaquo"</span>, 0x203A },</div><div class="line"><a name="l00510"></a><span class="lineno"> 510</span>  { <span class="stringliteral">"oline"</span>, 0x203E },</div><div class="line"><a name="l00511"></a><span class="lineno"> 511</span>  { <span class="stringliteral">"frasl"</span>, 0x2044 },</div><div class="line"><a name="l00512"></a><span class="lineno"> 512</span>  { <span class="stringliteral">"euro"</span>, 0x20AC },</div><div class="line"><a name="l00513"></a><span class="lineno"> 513</span>  { <span class="stringliteral">"image"</span>, 0x2111 },</div><div class="line"><a name="l00514"></a><span class="lineno"> 514</span>  { <span class="stringliteral">"weierp"</span>, 0x2118 },</div><div class="line"><a name="l00515"></a><span class="lineno"> 515</span>  { <span class="stringliteral">"real"</span>, 0x211C },</div><div class="line"><a name="l00516"></a><span class="lineno"> 516</span>  { <span class="stringliteral">"trade"</span>, 0x2122 },</div><div class="line"><a name="l00517"></a><span class="lineno"> 517</span>  { <span class="stringliteral">"alefsym"</span>, 0x2135 },</div><div class="line"><a name="l00518"></a><span class="lineno"> 518</span>  { <span class="stringliteral">"larr"</span>, 0x2190 },</div><div class="line"><a name="l00519"></a><span class="lineno"> 519</span>  { <span class="stringliteral">"uarr"</span>, 0x2191 },</div><div class="line"><a name="l00520"></a><span class="lineno"> 520</span>  { <span class="stringliteral">"rarr"</span>, 0x2192 },</div><div class="line"><a name="l00521"></a><span class="lineno"> 521</span>  { <span class="stringliteral">"darr"</span>, 0x2193 },</div><div class="line"><a name="l00522"></a><span class="lineno"> 522</span>  { <span class="stringliteral">"harr"</span>, 0x2194 },</div><div class="line"><a name="l00523"></a><span class="lineno"> 523</span>  { <span class="stringliteral">"crarr"</span>, 0x21B5 },</div><div class="line"><a name="l00524"></a><span class="lineno"> 524</span>  { <span class="stringliteral">"lArr"</span>, 0x21D0 },</div><div class="line"><a name="l00525"></a><span class="lineno"> 525</span>  { <span class="stringliteral">"uArr"</span>, 0x21D1 },</div><div class="line"><a name="l00526"></a><span class="lineno"> 526</span>  { <span class="stringliteral">"rArr"</span>, 0x21D2 },</div><div class="line"><a name="l00527"></a><span class="lineno"> 527</span>  { <span class="stringliteral">"dArr"</span>, 0x21D3 },</div><div class="line"><a name="l00528"></a><span class="lineno"> 528</span>  { <span class="stringliteral">"hArr"</span>, 0x21D4 },</div><div class="line"><a name="l00529"></a><span class="lineno"> 529</span>  { <span class="stringliteral">"forall"</span>, 0x2200 },</div><div class="line"><a name="l00530"></a><span class="lineno"> 530</span>  { <span class="stringliteral">"part"</span>, 0x2202 },</div><div class="line"><a name="l00531"></a><span class="lineno"> 531</span>  { <span class="stringliteral">"exist"</span>, 0x2203 },</div><div class="line"><a name="l00532"></a><span class="lineno"> 532</span>  { <span class="stringliteral">"empty"</span>, 0x2205 },</div><div class="line"><a name="l00533"></a><span class="lineno"> 533</span>  { <span class="stringliteral">"nabla"</span>, 0x2207 },</div><div class="line"><a name="l00534"></a><span class="lineno"> 534</span>  { <span class="stringliteral">"isin"</span>, 0x2208 },</div><div class="line"><a name="l00535"></a><span class="lineno"> 535</span>  { <span class="stringliteral">"notin"</span>, 0x2209 },</div><div class="line"><a name="l00536"></a><span class="lineno"> 536</span>  { <span class="stringliteral">"ni"</span>, 0x220B },</div><div class="line"><a name="l00537"></a><span class="lineno"> 537</span>  { <span class="stringliteral">"prod"</span>, 0x220F },</div><div class="line"><a name="l00538"></a><span class="lineno"> 538</span>  { <span class="stringliteral">"sum"</span>, 0x2211 },</div><div class="line"><a name="l00539"></a><span class="lineno"> 539</span>  { <span class="stringliteral">"minus"</span>, 0x2212 },</div><div class="line"><a name="l00540"></a><span class="lineno"> 540</span>  { <span class="stringliteral">"lowast"</span>, 0x2217 },</div><div class="line"><a name="l00541"></a><span class="lineno"> 541</span>  { <span class="stringliteral">"radic"</span>, 0x221A },</div><div class="line"><a name="l00542"></a><span class="lineno"> 542</span>  { <span class="stringliteral">"prop"</span>, 0x221D },</div><div class="line"><a name="l00543"></a><span class="lineno"> 543</span>  { <span class="stringliteral">"infin"</span>, 0x221E },</div><div class="line"><a name="l00544"></a><span class="lineno"> 544</span>  { <span class="stringliteral">"ang"</span>, 0x2220 },</div><div class="line"><a name="l00545"></a><span class="lineno"> 545</span>  { <span class="stringliteral">"and"</span>, 0x2227 },</div><div class="line"><a name="l00546"></a><span class="lineno"> 546</span>  { <span class="stringliteral">"or"</span>, 0x2228 },</div><div class="line"><a name="l00547"></a><span class="lineno"> 547</span>  { <span class="stringliteral">"cap"</span>, 0x2229 },</div><div class="line"><a name="l00548"></a><span class="lineno"> 548</span>  { <span class="stringliteral">"cup"</span>, 0x222A },</div><div class="line"><a name="l00549"></a><span class="lineno"> 549</span>  { <span class="stringliteral">"int"</span>, 0x222B },</div><div class="line"><a name="l00550"></a><span class="lineno"> 550</span>  { <span class="stringliteral">"there4"</span>, 0x2234 },</div><div class="line"><a name="l00551"></a><span class="lineno"> 551</span>  { <span class="stringliteral">"sim"</span>, 0x223C },</div><div class="line"><a name="l00552"></a><span class="lineno"> 552</span>  { <span class="stringliteral">"cong"</span>, 0x2245 },</div><div class="line"><a name="l00553"></a><span class="lineno"> 553</span>  { <span class="stringliteral">"asymp"</span>, 0x2248 },</div><div class="line"><a name="l00554"></a><span class="lineno"> 554</span>  { <span class="stringliteral">"ne"</span>, 0x2260 },</div><div class="line"><a name="l00555"></a><span class="lineno"> 555</span>  { <span class="stringliteral">"equiv"</span>, 0x2261 },</div><div class="line"><a name="l00556"></a><span class="lineno"> 556</span>  { <span class="stringliteral">"le"</span>, 0x2264 },</div><div class="line"><a name="l00557"></a><span class="lineno"> 557</span>  { <span class="stringliteral">"ge"</span>, 0x2265 },</div><div class="line"><a name="l00558"></a><span class="lineno"> 558</span>  { <span class="stringliteral">"sub"</span>, 0x2282 },</div><div class="line"><a name="l00559"></a><span class="lineno"> 559</span>  { <span class="stringliteral">"sup"</span>, 0x2283 },</div><div class="line"><a name="l00560"></a><span class="lineno"> 560</span>  { <span class="stringliteral">"nsub"</span>, 0x2284 },</div><div class="line"><a name="l00561"></a><span class="lineno"> 561</span>  { <span class="stringliteral">"sube"</span>, 0x2286 },</div><div class="line"><a name="l00562"></a><span class="lineno"> 562</span>  { <span class="stringliteral">"supe"</span>, 0x2287 },</div><div class="line"><a name="l00563"></a><span class="lineno"> 563</span>  { <span class="stringliteral">"oplus"</span>, 0x2295 },</div><div class="line"><a name="l00564"></a><span class="lineno"> 564</span>  { <span class="stringliteral">"otimes"</span>, 0x2297 },</div><div class="line"><a name="l00565"></a><span class="lineno"> 565</span>  { <span class="stringliteral">"perp"</span>, 0x22A5 },</div><div class="line"><a name="l00566"></a><span class="lineno"> 566</span>  { <span class="stringliteral">"sdot"</span>, 0x22C5 },</div><div class="line"><a name="l00567"></a><span class="lineno"> 567</span>  { <span class="stringliteral">"lceil"</span>, 0x2308 },</div><div class="line"><a name="l00568"></a><span class="lineno"> 568</span>  { <span class="stringliteral">"rceil"</span>, 0x2309 },</div><div class="line"><a name="l00569"></a><span class="lineno"> 569</span>  { <span class="stringliteral">"lfloor"</span>, 0x230A },</div><div class="line"><a name="l00570"></a><span class="lineno"> 570</span>  { <span class="stringliteral">"rfloor"</span>, 0x230B },</div><div class="line"><a name="l00571"></a><span class="lineno"> 571</span>  { <span class="stringliteral">"lang"</span>, 0x2329 },</div><div class="line"><a name="l00572"></a><span class="lineno"> 572</span>  { <span class="stringliteral">"rang"</span>, 0x232A },</div><div class="line"><a name="l00573"></a><span class="lineno"> 573</span>  { <span class="stringliteral">"loz"</span>, 0x25CA },</div><div class="line"><a name="l00574"></a><span class="lineno"> 574</span>  { <span class="stringliteral">"spades"</span>, 0x2660 },</div><div class="line"><a name="l00575"></a><span class="lineno"> 575</span>  { <span class="stringliteral">"clubs"</span>, 0x2663 },</div><div class="line"><a name="l00576"></a><span class="lineno"> 576</span>  { <span class="stringliteral">"hearts"</span>, 0x2665 },</div><div class="line"><a name="l00577"></a><span class="lineno"> 577</span>  { <span class="stringliteral">"diams"</span>, 0x2666 }</div><div class="line"><a name="l00578"></a><span class="lineno"> 578</span>  }};</div><div class="line"><a name="l00579"></a><span class="lineno"> 579</span> </div><div class="line"><a name="l00580"></a><span class="lineno"> 580</span>  <span class="keywordflow">for</span> (<span class="keyword">auto</span> &pair : names)</div><div class="line"><a name="l00581"></a><span class="lineno"> 581</span>  {</div><div class="line"><a name="l00582"></a><span class="lineno"> 582</span>  <span class="keyword">const</span> std::regex re(<span class="charliteral">'&'</span> + pair.first + <span class="charliteral">';'</span>);</div><div class="line"><a name="l00583"></a><span class="lineno"> 583</span>  output = std::regex_replace(output, re, u8c.to_bytes(pair.second));</div><div class="line"><a name="l00584"></a><span class="lineno"> 584</span>  }</div><div class="line"><a name="l00585"></a><span class="lineno"> 585</span> </div><div class="line"><a name="l00586"></a><span class="lineno"> 586</span>  <span class="keywordflow">return</span> output;</div><div class="line"><a name="l00587"></a><span class="lineno"> 587</span> }</div></div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a19891b68ebb8088e0fd748317704084d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a19891b68ebb8088e0fd748317704084d">◆ </a></span>urldecode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const std::string API::urldecode </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const string & </td>
|
|
<td class="paramname"><em>str</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Decodes a percent-encoded string. </p>
|
|
<p>Calls curlpp::unescape(str)</p>
|
|
<p>See RFC 3986 section 2.1 for more info.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">str</td><td>The string</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The decoded string</dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>0.18.0 </dd></dl>
|
|
<div class="fragment"><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> {</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <span class="keywordflow">return</span> curlpp::unescape(str);</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> }</div></div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a41e36cb4a94140e68084a85b959fa30b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a41e36cb4a94140e68084a85b959fa30b">◆ </a></span>urlencode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const std::string API::urlencode </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const string & </td>
|
|
<td class="paramname"><em>str</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Percent-encodes a string. This is done automatically, unless you make a custom request. </p>
|
|
<p>Calls curlpp::escape(str)</p>
|
|
<p>The only time you should use this, is if you use <a class="el" href="classMastodon_1_1API.html#abbeae53e9ee2402de9f7a38db16d2096" title="Make a custom GET request. ">get(const string &call, string &answer)</a>.</p>
|
|
<p>See RFC 3986 section 2.1 for more info.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">str</td><td>The string</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The percent-encoded string</dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>before 0.11.0 </dd></dl>
|
|
<div class="fragment"><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>  <span class="keywordflow">return</span> curlpp::escape(str);</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> }</div></div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/<a class="el" href="mastodon-cpp_8hpp_source.html">mastodon-cpp.hpp</a></li>
|
|
<li>src/mastodon-cpp.cpp</li>
|
|
<li>src/api/delete.cpp</li>
|
|
<li>src/api/get.cpp</li>
|
|
<li>src/api/get_stream.cpp</li>
|
|
<li>src/api/patch.cpp</li>
|
|
<li>src/api/post.cpp</li>
|
|
<li>src/api/put.cpp</li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.14
|
|
</small></address>
|
|
</body>
|
|
</html>
|