mastodonpp/docs/classmastodonpp_1_1API.html

156 lines
6.9 KiB
HTML
Raw Normal View History

2020-01-03 11:14:21 +01:00
<!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"><b>mastodonpp</b></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-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>C++ wrapper for the Mastodon <a class="el" href="classmastodonpp_1_1API.html" title="C++ wrapper for the Mastodon API.">API</a>.
<a href="classmastodonpp_1_1API.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="mastodonpp_8hpp_source.html">mastodonpp.hpp</a>&gt;</code></p>
<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:a1c465687c763297b0fa1086f905015a8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1API.html#a1c465687c763297b0fa1086f905015a8">API</a> (string instance, string access_token)</td></tr>
<tr class="memdesc:a1c465687c763297b0fa1086f905015a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a new <a class="el" href="classmastodonpp_1_1API.html" title="C++ wrapper for the Mastodon API.">API</a> object. <a href="classmastodonpp_1_1API.html#a1c465687c763297b0fa1086f905015a8">More...</a><br /></td></tr>
<tr class="separator:a1c465687c763297b0fa1086f905015a8"><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>C++ wrapper for the Mastodon <a class="el" href="classmastodonpp_1_1API.html" title="C++ wrapper for the Mastodon API.">API</a>. </p>
<p>All text input is expected to be UTF-8.</p>
<dl class="section since"><dt>Since</dt><dd>0.1.0 </dd></dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a1c465687c763297b0fa1086f905015a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1c465687c763297b0fa1086f905015a8">&#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">string&#160;</td>
<td class="paramname"><em>instance</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>access_token</em>&#160;</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>Construct a new <a class="el" href="classmastodonpp_1_1API.html" title="C++ wrapper for the Mastodon API.">API</a> object. </p>
2020-01-03 11:27:43 +01:00
<p>To register your application, leave access_token blank and call API::register_app1() and API::register_app2().</p>
2020-01-03 11:14:21 +01:00
<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>0.1.0 </dd></dl>
<div class="fragment"><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; : _instance{move(instance)}</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; , _access_token{move(access_token)}</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</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="mastodonpp_8hpp_source.html">mastodonpp.hpp</a></li>
<li>src/mastodonpp.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>