144 lines
13 KiB
HTML
144 lines
13 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.16"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>mastodonpp: include/api.hpp Source File</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">mastodonpp
|
|
 <span id="projectnumber">0.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&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&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="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">api.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* This file is part of mastodonpp.</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright © 2020 tastytea <tastytea@tastytea.de></span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * This program is free software: you can redistribute it and/or modify</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * it under the terms of the GNU Affero General Public License as published by</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * the Free Software Foundation, version 3.</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * This program is distributed in the hope that it will be useful,</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * GNU Affero General Public License for more details.</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * You should have received a copy of the GNU Affero General Public License</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * along with this program. If not, see <http://www.gnu.org/licenses/>.</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  </div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#ifndef MASTODONPP_API_HPP</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#define MASTODONPP_API_HPP</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <map></span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <string></span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <variant></span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  </div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">namespace </span><a class="code" href="namespacemastodonpp.html">mastodonpp</a></div>
|
|
<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>  </div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">using</span> std::string;</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">using</span> std::variant;</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  </div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classmastodonpp_1_1API.html"> 35</a></span> <span class="keyword">class </span><a class="code" href="classmastodonpp_1_1API.html">API</a></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="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classmastodonpp_1_1API.html#aee8f590426914a36f948dafa78e330f2"> 45</a></span>  <span class="keyword">enum class</span> <a class="code" href="classmastodonpp_1_1API.html#aee8f590426914a36f948dafa78e330f2">v1</a></div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  {</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  instance</div>
|
|
<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>  </div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="classmastodonpp_1_1API.html#a67ba7c7a8d94ec7905e45466255648ba"> 57</a></span>  <span class="keyword">enum class</span> <a class="code" href="classmastodonpp_1_1API.html#a67ba7c7a8d94ec7905e45466255648ba">v2</a></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>  search</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  };</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  </div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="classmastodonpp_1_1API.html#afab8f6d794dbe28dde47d39b53822e82"> 67</a></span>  <span class="keyword">using</span> <a class="code" href="classmastodonpp_1_1API.html#afab8f6d794dbe28dde47d39b53822e82">endpoint_type</a> = variant<v1,v2>;</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  </div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keyword">explicit</span> <a class="code" href="classmastodonpp_1_1API.html#ab119ba2638c43388423e9c01c14c9246">API</a>(<a class="code" href="classmastodonpp_1_1API.html#afab8f6d794dbe28dde47d39b53822e82">endpoint_type</a> &endpoint);</div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  </div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordtype">string</span> <a class="code" href="classmastodonpp_1_1API.html#a0dc773350528fe78be20cf57d3109a9c">to_string</a>() <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  </div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keyword">const</span> <a class="code" href="classmastodonpp_1_1API.html#afab8f6d794dbe28dde47d39b53822e82">endpoint_type</a> _endpoint;</div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> };</div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  </div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> } <span class="comment">// namespace mastodonpp</span></div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  </div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="preprocessor">#endif // MASTODONPP_API_HPP</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="aclassmastodonpp_1_1API_html_a67ba7c7a8d94ec7905e45466255648ba"><div class="ttname"><a href="classmastodonpp_1_1API.html#a67ba7c7a8d94ec7905e45466255648ba">mastodonpp::API::v2</a></div><div class="ttdeci">v2</div><div class="ttdoc">An enumeration of all v2 API endpoints.</div><div class="ttdef"><b>Definition:</b> api.hpp:57</div></div>
|
|
<div class="ttc" id="aclassmastodonpp_1_1API_html_a0dc773350528fe78be20cf57d3109a9c"><div class="ttname"><a href="classmastodonpp_1_1API.html#a0dc773350528fe78be20cf57d3109a9c">mastodonpp::API::to_string</a></div><div class="ttdeci">string to_string() const</div><div class="ttdoc">Convert endpoint_type to string.</div><div class="ttdef"><b>Definition:</b> api.cpp:34</div></div>
|
|
<div class="ttc" id="anamespacemastodonpp_html"><div class="ttname"><a href="namespacemastodonpp.html">mastodonpp</a></div><div class="ttdoc">C++ wrapper for the Mastodon API.</div><div class="ttdef"><b>Definition:</b> api.cpp:23</div></div>
|
|
<div class="ttc" id="aclassmastodonpp_1_1API_html_ab119ba2638c43388423e9c01c14c9246"><div class="ttname"><a href="classmastodonpp_1_1API.html#ab119ba2638c43388423e9c01c14c9246">mastodonpp::API::API</a></div><div class="ttdeci">API(endpoint_type &endpoint)</div><div class="ttdoc">Constructs an API object. You should never need this.</div><div class="ttdef"><b>Definition:</b> api.cpp:30</div></div>
|
|
<div class="ttc" id="aclassmastodonpp_1_1API_html"><div class="ttname"><a href="classmastodonpp_1_1API.html">mastodonpp::API</a></div><div class="ttdoc">Holds API endpoints.</div><div class="ttdef"><b>Definition:</b> api.hpp:35</div></div>
|
|
<div class="ttc" id="aclassmastodonpp_1_1API_html_aee8f590426914a36f948dafa78e330f2"><div class="ttname"><a href="classmastodonpp_1_1API.html#aee8f590426914a36f948dafa78e330f2">mastodonpp::API::v1</a></div><div class="ttdeci">v1</div><div class="ttdoc">An enumeration of all v1 API endpoints.</div><div class="ttdef"><b>Definition:</b> api.hpp:45</div></div>
|
|
<div class="ttc" id="aclassmastodonpp_1_1API_html_afab8f6d794dbe28dde47d39b53822e82"><div class="ttname"><a href="classmastodonpp_1_1API.html#afab8f6d794dbe28dde47d39b53822e82">mastodonpp::API::endpoint_type</a></div><div class="ttdeci">variant< v1, v2 > endpoint_type</div><div class="ttdoc">Type for endpoints. Either API::v1 or API::v2.</div><div class="ttdef"><b>Definition:</b> api.hpp:67</div></div>
|
|
<!-- 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.16
|
|
</small></address>
|
|
</body>
|
|
</html>
|