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

241 lines
17 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::Request 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_1Request.html">Request</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_1Request-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mastodonpp::Request Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Used to make a request to the Mastodon API.
<a href="classmastodonpp_1_1Request.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="request_8hpp_source.html">mastodonpp/request.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for mastodonpp::Request:</div>
<div class="dyncontent">
<div class="center">
<img src="classmastodonpp_1_1Request.png" usemap="#mastodonpp::Request_map" alt=""/>
<map id="mastodonpp::Request_map" name="mastodonpp::Request_map">
<area href="classmastodonpp_1_1CURLWrapper.html" title="Handles the details of network connections." alt="mastodonpp::CURLWrapper" shape="rect" coords="0,0,166,24"/>
</map>
</div></div>
<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:ab79b1b1c9172b6bd6aebd212f31d9a85"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1Request.html#ab79b1b1c9172b6bd6aebd212f31d9a85">Request</a> (<a class="el" href="classmastodonpp_1_1Instance.html">Instance</a> &amp;instance)</td></tr>
<tr class="memdesc:ab79b1b1c9172b6bd6aebd212f31d9a85"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a new <a class="el" href="classmastodonpp_1_1Request.html" title="Used to make a request to the Mastodon API.">Request</a> object. <a href="classmastodonpp_1_1Request.html#ab79b1b1c9172b6bd6aebd212f31d9a85">More...</a><br /></td></tr>
<tr class="separator:ab79b1b1c9172b6bd6aebd212f31d9a85"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abf980d36a6ccb5eadee1cd9ef80baf0d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmastodonpp_1_1answer__type.html">answer_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1Request.html#abf980d36a6ccb5eadee1cd9ef80baf0d">get</a> (<a class="el" href="classmastodonpp_1_1API.html#afab8f6d794dbe28dde47d39b53822e82">API::endpoint_type</a> endpoint) const</td></tr>
<tr class="memdesc:abf980d36a6ccb5eadee1cd9ef80baf0d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Make a HTTP GET call. <a href="classmastodonpp_1_1Request.html#abf980d36a6ccb5eadee1cd9ef80baf0d">More...</a><br /></td></tr>
<tr class="separator:abf980d36a6ccb5eadee1cd9ef80baf0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4aa3d13bf39d4263811242ef39a1fdb5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmastodonpp_1_1answer__type.html">answer_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1Request.html#a4aa3d13bf39d4263811242ef39a1fdb5">get</a> (string endpoint) const</td></tr>
<tr class="memdesc:a4aa3d13bf39d4263811242ef39a1fdb5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Make a HTTP GET call. <a href="classmastodonpp_1_1Request.html#a4aa3d13bf39d4263811242ef39a1fdb5">More...</a><br /></td></tr>
<tr class="separator:a4aa3d13bf39d4263811242ef39a1fdb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classmastodonpp_1_1CURLWrapper"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classmastodonpp_1_1CURLWrapper')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classmastodonpp_1_1CURLWrapper.html">mastodonpp::CURLWrapper</a></td></tr>
<tr class="memitem:a736572303fbec7a307514e611e6a468c inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1CURLWrapper.html#a736572303fbec7a307514e611e6a468c">CURLWrapper</a> ()</td></tr>
<tr class="memdesc:a736572303fbec7a307514e611e6a468c inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes curl and sets up connection. <a href="classmastodonpp_1_1CURLWrapper.html#a736572303fbec7a307514e611e6a468c">More...</a><br /></td></tr>
<tr class="separator:a736572303fbec7a307514e611e6a468c inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a51ff58f1038ea1d6c8d327b5f261ae39 inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1CURLWrapper.html#a51ff58f1038ea1d6c8d327b5f261ae39">CURLWrapper</a> (const <a class="el" href="classmastodonpp_1_1CURLWrapper.html">CURLWrapper</a> &amp;other)=default</td></tr>
<tr class="memdesc:a51ff58f1038ea1d6c8d327b5f261ae39 inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy constructor. <a href="classmastodonpp_1_1CURLWrapper.html#a51ff58f1038ea1d6c8d327b5f261ae39">More...</a><br /></td></tr>
<tr class="separator:a51ff58f1038ea1d6c8d327b5f261ae39 inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1969bc0fb2e104d896c606b38f3199e7 inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1CURLWrapper.html#a1969bc0fb2e104d896c606b38f3199e7">CURLWrapper</a> (<a class="el" href="classmastodonpp_1_1CURLWrapper.html">CURLWrapper</a> &amp;&amp;other) noexcept=default</td></tr>
<tr class="memdesc:a1969bc0fb2e104d896c606b38f3199e7 inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move constructor. <a href="classmastodonpp_1_1CURLWrapper.html#a1969bc0fb2e104d896c606b38f3199e7">More...</a><br /></td></tr>
<tr class="separator:a1969bc0fb2e104d896c606b38f3199e7 inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a350f7061c9cb54cb5992ae983db3fc19 inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1CURLWrapper.html#a350f7061c9cb54cb5992ae983db3fc19">~CURLWrapper</a> () noexcept</td></tr>
<tr class="memdesc:a350f7061c9cb54cb5992ae983db3fc19 inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cleans up curl and connection. <a href="classmastodonpp_1_1CURLWrapper.html#a350f7061c9cb54cb5992ae983db3fc19">More...</a><br /></td></tr>
<tr class="separator:a350f7061c9cb54cb5992ae983db3fc19 inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ab0da0f9186df2bdbf65189df57aeaf inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmastodonpp_1_1CURLWrapper.html">CURLWrapper</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1CURLWrapper.html#a9ab0da0f9186df2bdbf65189df57aeaf">operator=</a> (const <a class="el" href="classmastodonpp_1_1CURLWrapper.html">CURLWrapper</a> &amp;other)=default</td></tr>
<tr class="memdesc:a9ab0da0f9186df2bdbf65189df57aeaf inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy assignment operator. <a href="classmastodonpp_1_1CURLWrapper.html#a9ab0da0f9186df2bdbf65189df57aeaf">More...</a><br /></td></tr>
<tr class="separator:a9ab0da0f9186df2bdbf65189df57aeaf inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab516c58e5887eedc4b3b475c8faa060a inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmastodonpp_1_1CURLWrapper.html">CURLWrapper</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1CURLWrapper.html#ab516c58e5887eedc4b3b475c8faa060a">operator=</a> (<a class="el" href="classmastodonpp_1_1CURLWrapper.html">CURLWrapper</a> &amp;&amp;other) noexcept=default</td></tr>
<tr class="memdesc:ab516c58e5887eedc4b3b475c8faa060a inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move assignment operator. <a href="classmastodonpp_1_1CURLWrapper.html#ab516c58e5887eedc4b3b475c8faa060a">More...</a><br /></td></tr>
<tr class="separator:ab516c58e5887eedc4b3b475c8faa060a inherit pub_methods_classmastodonpp_1_1CURLWrapper"><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>Used to make a request to the Mastodon API. </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="ab79b1b1c9172b6bd6aebd212f31d9a85"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab79b1b1c9172b6bd6aebd212f31d9a85">&#9670;&nbsp;</a></span>Request()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">mastodonpp::Request::Request </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmastodonpp_1_1Instance.html">Instance</a> &amp;&#160;</td>
<td class="paramname"><em>instance</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>Construct a new <a class="el" href="classmastodonpp_1_1Request.html" title="Used to make a request to the Mastodon API.">Request</a> object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">instance</td><td>An <a class="el" href="classmastodonpp_1_1Instance.html" title="Holds the access data of an instance.">Instance</a> with the access data.</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="l00023"></a><span class="lineno"> 23</span>&#160; : _instance{instance}</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;{}</div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="abf980d36a6ccb5eadee1cd9ef80baf0d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abf980d36a6ccb5eadee1cd9ef80baf0d">&#9670;&nbsp;</a></span>get() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structmastodonpp_1_1answer__type.html">answer_type</a> mastodonpp::Request::get </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmastodonpp_1_1API.html#afab8f6d794dbe28dde47d39b53822e82">API::endpoint_type</a>&#160;</td>
<td class="paramname"><em>endpoint</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Make a HTTP GET call. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">endpoint</td><td>Endpoint as <a class="el" href="classmastodonpp_1_1API.html#afab8f6d794dbe28dde47d39b53822e82" title="Type for endpoints. Either API::v1 or API::v2.">API::endpoint_type</a>, for example: <code>mastodonpp::API::v1::instance</code>.</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;{</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; answer_type answer;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; answer.body = API{endpoint}.to_string();</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keywordflow">return</span> answer;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;}</div>
</div><!-- fragment -->
</div>
</div>
<a id="a4aa3d13bf39d4263811242ef39a1fdb5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4aa3d13bf39d4263811242ef39a1fdb5">&#9670;&nbsp;</a></span>get() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structmastodonpp_1_1answer__type.html">answer_type</a> mastodonpp::Request::get </td>
<td>(</td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>endpoint</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Make a HTTP GET call. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">endpoint</td><td>Endpoint as string, for example: "/api/v1/instance".</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="l00034"></a><span class="lineno"> 34</span>&#160;{</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; answer_type answer;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; answer.body = endpoint;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keywordflow">return</span> answer;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</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="request_8hpp_source.html">request.hpp</a></li>
<li>src/request.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