tastytea/mastodonpp
2
1
Fork 0
Code Issues Pull Requests Releases 12 Wiki Activity
61b6deaa3c
mastodonpp/docs/classmastodonpp_1_1API.html
tastytea 61b6deaa3c
2020-01-05
2020-01-05 13:28:39 +01:00

261 lines
15 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.16"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>mastodonpp: mastodonpp::API Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">mastodonpp
&#160;<span id="projectnumber">0.0.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacemastodonpp.html">mastodonpp</a></li><li class="navelem"><a class="el" href="classmastodonpp_1_1API.html">API</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classmastodonpp_1_1API-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mastodonpp::API Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Holds <a class="el" href="classmastodonpp_1_1API.html" title="Holds API endpoints.">API</a> endpoints.
<a href="classmastodonpp_1_1API.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="api_8hpp_source.html">mastodonpp/api.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:aee8f590426914a36f948dafa78e330f2"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1API.html#aee8f590426914a36f948dafa78e330f2">v1</a> { <b>instance</b>
}</td></tr>
<tr class="memdesc:aee8f590426914a36f948dafa78e330f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">An enumeration of all v1 API endpoints. <a href="classmastodonpp_1_1API.html#aee8f590426914a36f948dafa78e330f2">More...</a><br /></td></tr>
<tr class="separator:aee8f590426914a36f948dafa78e330f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a67ba7c7a8d94ec7905e45466255648ba"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1API.html#a67ba7c7a8d94ec7905e45466255648ba">v2</a> { <b>search</b>
}</td></tr>
<tr class="memdesc:a67ba7c7a8d94ec7905e45466255648ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">An enumeration of all v2 API endpoints. <a href="classmastodonpp_1_1API.html#a67ba7c7a8d94ec7905e45466255648ba">More...</a><br /></td></tr>
<tr class="separator:a67ba7c7a8d94ec7905e45466255648ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afab8f6d794dbe28dde47d39b53822e82"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1API.html#afab8f6d794dbe28dde47d39b53822e82">endpoint_type</a> = variant&lt; <a class="el" href="classmastodonpp_1_1API.html#aee8f590426914a36f948dafa78e330f2">v1</a>, <a class="el" href="classmastodonpp_1_1API.html#a67ba7c7a8d94ec7905e45466255648ba">v2</a> &gt;</td></tr>
<tr class="memdesc:afab8f6d794dbe28dde47d39b53822e82"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type for endpoints. Either <a class="el" href="classmastodonpp_1_1API.html#aee8f590426914a36f948dafa78e330f2" title="An enumeration of all v1 API endpoints.">API::v1</a> or <a class="el" href="classmastodonpp_1_1API.html#a67ba7c7a8d94ec7905e45466255648ba" title="An enumeration of all v2 API endpoints.">API::v2</a>. <a href="classmastodonpp_1_1API.html#afab8f6d794dbe28dde47d39b53822e82">More...</a><br /></td></tr>
<tr class="separator:afab8f6d794dbe28dde47d39b53822e82"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:af9fc7a7d152a851122f8acc3224d4047"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1API.html#af9fc7a7d152a851122f8acc3224d4047">API</a> (const <a class="el" href="classmastodonpp_1_1API.html#afab8f6d794dbe28dde47d39b53822e82">endpoint_type</a> &amp;endpoint)</td></tr>
<tr class="memdesc:af9fc7a7d152a851122f8acc3224d4047"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an <a class="el" href="classmastodonpp_1_1API.html" title="Holds API endpoints.">API</a> object. You should never need this. <a href="classmastodonpp_1_1API.html#af9fc7a7d152a851122f8acc3224d4047">More...</a><br /></td></tr>
<tr class="separator:af9fc7a7d152a851122f8acc3224d4047"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa51c43b5c7cc2afd32520d08d51bcfc3"><td class="memItemLeft" align="right" valign="top">string_view&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1API.html#aa51c43b5c7cc2afd32520d08d51bcfc3">to_string_view</a> () const</td></tr>
<tr class="memdesc:aa51c43b5c7cc2afd32520d08d51bcfc3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert <a class="el" href="classmastodonpp_1_1API.html#afab8f6d794dbe28dde47d39b53822e82" title="Type for endpoints. Either API::v1 or API::v2.">endpoint_type</a> to <code>std::string_view</code>. <a href="classmastodonpp_1_1API.html#aa51c43b5c7cc2afd32520d08d51bcfc3">More...</a><br /></td></tr>
<tr class="separator:aa51c43b5c7cc2afd32520d08d51bcfc3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Holds <a class="el" href="classmastodonpp_1_1API.html" title="Holds API endpoints.">API</a> endpoints. </p>
<dl class="section since"><dt>Since</dt><dd>0.1.0 </dd></dl>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="afab8f6d794dbe28dde47d39b53822e82"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afab8f6d794dbe28dde47d39b53822e82">&#9670;&nbsp;</a></span>endpoint_type</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classmastodonpp_1_1API.html#afab8f6d794dbe28dde47d39b53822e82">mastodonpp::API::endpoint_type</a> = variant&lt;<a class="el" href="classmastodonpp_1_1API.html#aee8f590426914a36f948dafa78e330f2">v1</a>,<a class="el" href="classmastodonpp_1_1API.html#a67ba7c7a8d94ec7905e45466255648ba">v2</a>&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p>Type for endpoints. Either <a class="el" href="classmastodonpp_1_1API.html#aee8f590426914a36f948dafa78e330f2" title="An enumeration of all v1 API endpoints.">API::v1</a> or <a class="el" href="classmastodonpp_1_1API.html#a67ba7c7a8d94ec7905e45466255648ba" title="An enumeration of all v2 API endpoints.">API::v2</a>. </p>
<dl class="section since"><dt>Since</dt><dd>0.1.0 </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="aee8f590426914a36f948dafa78e330f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aee8f590426914a36f948dafa78e330f2">&#9670;&nbsp;</a></span>v1</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classmastodonpp_1_1API.html#aee8f590426914a36f948dafa78e330f2">mastodonpp::API::v1</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>An enumeration of all v1 API endpoints. </p>
<p>The original <code>/</code> are substituted with <code>_</code>.</p>
<dl class="section since"><dt>Since</dt><dd>0.1.0 </dd></dl>
<div class="fragment"><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; {</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; instance</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; };</div>
</div><!-- fragment -->
</div>
</div>
<a id="a67ba7c7a8d94ec7905e45466255648ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a67ba7c7a8d94ec7905e45466255648ba">&#9670;&nbsp;</a></span>v2</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classmastodonpp_1_1API.html#a67ba7c7a8d94ec7905e45466255648ba">mastodonpp::API::v2</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>An enumeration of all v2 API endpoints. </p>
<p>The original <code>/</code> are substituted with <code>_</code>.</p>
<dl class="section since"><dt>Since</dt><dd>0.1.0 </dd></dl>
<div class="fragment"><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; {</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; search</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; };</div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="af9fc7a7d152a851122f8acc3224d4047"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af9fc7a7d152a851122f8acc3224d4047">&#9670;&nbsp;</a></span>API()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">mastodonpp::API::API </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmastodonpp_1_1API.html#afab8f6d794dbe28dde47d39b53822e82">endpoint_type</a> &amp;&#160;</td>
<td class="paramname"><em>endpoint</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs an <a class="el" href="classmastodonpp_1_1API.html" title="Holds API endpoints.">API</a> object. You should never need this. </p>
<p>This constructor exists to hide away the class members, which are used internally.</p>
<dl class="section since"><dt>Since</dt><dd>0.1.0 </dd></dl>
<div class="fragment"><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; : _endpoint{endpoint}</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;{}</div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aa51c43b5c7cc2afd32520d08d51bcfc3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa51c43b5c7cc2afd32520d08d51bcfc3">&#9670;&nbsp;</a></span>to_string_view()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string_view mastodonpp::API::to_string_view </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert <a class="el" href="classmastodonpp_1_1API.html#afab8f6d794dbe28dde47d39b53822e82" title="Type for endpoints. Either API::v1 or API::v2.">endpoint_type</a> to <code>std::string_view</code>. </p>
<dl class="section since"><dt>Since</dt><dd>0.1.0 </dd></dl>
<div class="fragment"><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;{</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> map&lt;endpoint_type,string_view&gt; endpoint_map</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; {</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; {v1::instance, <span class="stringliteral">&quot;/api/v1/instance&quot;</span>},</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; {v2::search, <span class="stringliteral">&quot;/api/v2/search&quot;</span>}</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; };</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keywordflow">return</span> endpoint_map.at(_endpoint).data();</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;}</div>
</div><!-- fragment -->
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>include/<a class="el" href="api_8hpp_source.html">api.hpp</a></li>
<li>src/api.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.16
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink