This repository has been archived on 2020-05-10. You can view files and clone it, but cannot push or open issues or pull requests.
mastodon-cpp/docs/structMastodon_1_1return__c...

324 lines
27 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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>mastodon-cpp: Mastodon::return_call Struct 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
&#160;<span id="projectnumber">0.110.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<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('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceMastodon.html">Mastodon</a></li><li class="navelem"><a class="el" href="structMastodon_1_1return__call.html">return_call</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="structMastodon_1_1return__call-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Mastodon::return_call Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Return type for <a class="el" href="classMastodon_1_1API.html" title="Interface to the Mastodon API.">API</a> calls.
<a href="structMastodon_1_1return__call.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="return__types_8hpp_source.html">return_types.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for Mastodon::return_call:</div>
<div class="dyncontent">
<div class="center">
<img src="structMastodon_1_1return__call.png" usemap="#Mastodon::return_5Fcall_map" alt=""/>
<map id="Mastodon::return_5Fcall_map" name="Mastodon::return_5Fcall_map">
<area href="structMastodon_1_1return__base.html" title="Basis for return types." alt="Mastodon::return_base" shape="rect" coords="0,0,141,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:a51cceebc3e5cc3e9dd24b8fc018ee0ce"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMastodon_1_1return__call.html#a51cceebc3e5cc3e9dd24b8fc018ee0ce">return_call</a> (const uint8_t ec, const string &amp;em, const uint16_t hec, const string &amp;a)</td></tr>
<tr class="memdesc:a51cceebc3e5cc3e9dd24b8fc018ee0ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return type for <a class="el" href="classMastodon_1_1API.html" title="Interface to the Mastodon API.">Mastodon::API</a>. <a href="#a51cceebc3e5cc3e9dd24b8fc018ee0ce">More...</a><br /></td></tr>
<tr class="separator:a51cceebc3e5cc3e9dd24b8fc018ee0ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3aafabc74733c8dfeaa81c3f10c5cbe0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMastodon_1_1return__call.html#a3aafabc74733c8dfeaa81c3f10c5cbe0">return_call</a> (const error ec, const string &amp;em, const uint16_t hec, const string &amp;a)</td></tr>
<tr class="memdesc:a3aafabc74733c8dfeaa81c3f10c5cbe0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return type for <a class="el" href="classMastodon_1_1API.html" title="Interface to the Mastodon API.">Mastodon::API</a>. <a href="#a3aafabc74733c8dfeaa81c3f10c5cbe0">More...</a><br /></td></tr>
<tr class="separator:a3aafabc74733c8dfeaa81c3f10c5cbe0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af8eed5b7fdb3dac4085e3c74e8ad9f9f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMastodon_1_1return__call.html#af8eed5b7fdb3dac4085e3c74e8ad9f9f">operator const string</a> () const</td></tr>
<tr class="memdesc:af8eed5b7fdb3dac4085e3c74e8ad9f9f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Same es <a class="el" href="structMastodon_1_1return__call.html#a8d9ac799e26fc5ff54592083a8a83404" title="The response from the server.">return_call::answer</a>. <a href="#af8eed5b7fdb3dac4085e3c74e8ad9f9f">More...</a><br /></td></tr>
<tr class="separator:af8eed5b7fdb3dac4085e3c74e8ad9f9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_structMastodon_1_1return__base"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structMastodon_1_1return__base')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="structMastodon_1_1return__base.html">Mastodon::return_base</a></td></tr>
<tr class="memitem:ad08f011a810e67bb2bee01ebe5cde1fa inherit pub_methods_structMastodon_1_1return__base"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMastodon_1_1return__base.html#ad08f011a810e67bb2bee01ebe5cde1fa">operator bool</a> () const</td></tr>
<tr class="memdesc:ad08f011a810e67bb2bee01ebe5cde1fa inherit pub_methods_structMastodon_1_1return__base"><td class="mdescLeft">&#160;</td><td class="mdescRight">true if <a class="el" href="structMastodon_1_1return__base.html#a12cebffae19249cac4c9e4ae9f95391a" title="Error code.">return_base::error_code</a> is 0, otherwise false. <a href="structMastodon_1_1return__base.html#ad08f011a810e67bb2bee01ebe5cde1fa">More...</a><br /></td></tr>
<tr class="separator:ad08f011a810e67bb2bee01ebe5cde1fa inherit pub_methods_structMastodon_1_1return__base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3331b0ca8f1c999fd6d21f4ce4b4e68f inherit pub_methods_structMastodon_1_1return__base"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMastodon_1_1return__base.html#a3331b0ca8f1c999fd6d21f4ce4b4e68f">operator uint8_t</a> () const</td></tr>
<tr class="memdesc:a3331b0ca8f1c999fd6d21f4ce4b4e68f inherit pub_methods_structMastodon_1_1return__base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Same as <a class="el" href="structMastodon_1_1return__base.html#a12cebffae19249cac4c9e4ae9f95391a" title="Error code.">return_base::error_code</a>. <a href="structMastodon_1_1return__base.html#a3331b0ca8f1c999fd6d21f4ce4b4e68f">More...</a><br /></td></tr>
<tr class="separator:a3331b0ca8f1c999fd6d21f4ce4b4e68f inherit pub_methods_structMastodon_1_1return__base"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a8d9ac799e26fc5ff54592083a8a83404"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMastodon_1_1return__call.html#a8d9ac799e26fc5ff54592083a8a83404">answer</a></td></tr>
<tr class="memdesc:a8d9ac799e26fc5ff54592083a8a83404"><td class="mdescLeft">&#160;</td><td class="mdescRight">The response from the server. <a href="#a8d9ac799e26fc5ff54592083a8a83404">More...</a><br /></td></tr>
<tr class="separator:a8d9ac799e26fc5ff54592083a8a83404"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_attribs_structMastodon_1_1return__base"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_structMastodon_1_1return__base')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="structMastodon_1_1return__base.html">Mastodon::return_base</a></td></tr>
<tr class="memitem:a12cebffae19249cac4c9e4ae9f95391a inherit pub_attribs_structMastodon_1_1return__base"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMastodon_1_1return__base.html#a12cebffae19249cac4c9e4ae9f95391a">error_code</a> = 0</td></tr>
<tr class="memdesc:a12cebffae19249cac4c9e4ae9f95391a inherit pub_attribs_structMastodon_1_1return__base"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classMastodon_1_1API.html#error">Error code</a>. <a href="structMastodon_1_1return__base.html#a12cebffae19249cac4c9e4ae9f95391a">More...</a><br /></td></tr>
<tr class="separator:a12cebffae19249cac4c9e4ae9f95391a inherit pub_attribs_structMastodon_1_1return__base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab902d5ecac698fadbdcabcd99d0ce754 inherit pub_attribs_structMastodon_1_1return__base"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMastodon_1_1return__base.html#ab902d5ecac698fadbdcabcd99d0ce754">error_message</a></td></tr>
<tr class="memdesc:ab902d5ecac698fadbdcabcd99d0ce754 inherit pub_attribs_structMastodon_1_1return__base"><td class="mdescLeft">&#160;</td><td class="mdescRight">The error message, or "". <a href="structMastodon_1_1return__base.html#ab902d5ecac698fadbdcabcd99d0ce754">More...</a><br /></td></tr>
<tr class="separator:ab902d5ecac698fadbdcabcd99d0ce754 inherit pub_attribs_structMastodon_1_1return__base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af62546b8b4bb03899ddbec770065e0b6 inherit pub_attribs_structMastodon_1_1return__base"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMastodon_1_1return__base.html#af62546b8b4bb03899ddbec770065e0b6">http_error_code</a> = 0</td></tr>
<tr class="memdesc:af62546b8b4bb03899ddbec770065e0b6 inherit pub_attribs_structMastodon_1_1return__base"><td class="mdescLeft">&#160;</td><td class="mdescRight">HTTP error code. <a href="structMastodon_1_1return__base.html#af62546b8b4bb03899ddbec770065e0b6">More...</a><br /></td></tr>
<tr class="separator:af62546b8b4bb03899ddbec770065e0b6 inherit pub_attribs_structMastodon_1_1return__base"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a9a83900af66c00acd9c26da38de17af8"><td class="memItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMastodon_1_1return__call.html#a9a83900af66c00acd9c26da38de17af8">operator&lt;&lt;</a> (std::ostream &amp;out, const <a class="el" href="structMastodon_1_1return__call.html">return_call</a> &amp;ret)</td></tr>
<tr class="memdesc:a9a83900af66c00acd9c26da38de17af8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Same es <a class="el" href="structMastodon_1_1return__call.html#a8d9ac799e26fc5ff54592083a8a83404" title="The response from the server.">return_call::answer</a>. <a href="#a9a83900af66c00acd9c26da38de17af8">More...</a><br /></td></tr>
<tr class="separator:a9a83900af66c00acd9c26da38de17af8"><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>Return type for <a class="el" href="classMastodon_1_1API.html" title="Interface to the Mastodon API.">API</a> calls. </p>
<p>Example: </p><div class="fragment"><div class="line"><a class="code" href="structMastodon_1_1return__call.html">Mastodon::return_call</a> ret = masto.get(Mastodon::API::v1::instance);</div><div class="line"><span class="keywordflow">if</span> (!ret) <span class="comment">// Or ret.error_code != 0</span></div><div class="line">{</div><div class="line"> cout &lt;&lt; <span class="stringliteral">&quot;Error &quot;</span> &lt;&lt; std::to_string(ret.<a class="code" href="structMastodon_1_1return__base.html#a12cebffae19249cac4c9e4ae9f95391a">error_code</a>);</div><div class="line"> cout &lt;&lt; <span class="stringliteral">&quot; (HTTP &quot;</span> &lt;&lt; std::to_string(ret.<a class="code" href="structMastodon_1_1return__base.html#af62546b8b4bb03899ddbec770065e0b6">http_error_code</a>) &lt;&lt; <span class="stringliteral">&quot;): &quot;</span>;</div><div class="line"> cout &lt;&lt; ret.<a class="code" href="structMastodon_1_1return__base.html#ab902d5ecac698fadbdcabcd99d0ce754">error_message</a> &lt;&lt; endl</div><div class="line">}</div><div class="line"><span class="keywordflow">else</span></div><div class="line">{</div><div class="line"> cout &lt;&lt; ret &lt;&lt; endl; <span class="comment">// Or ret.answer</span></div><div class="line">}</div></div><!-- fragment --><dl class="section since"><dt>Since</dt><dd>0.100.0 </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="example01_get_public_timeline_8cpp-example.html#_a1">example01_get_public_timeline.cpp</a>.</dd>
</dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a51cceebc3e5cc3e9dd24b8fc018ee0ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a51cceebc3e5cc3e9dd24b8fc018ee0ce">&#9670;&nbsp;</a></span>return_call() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Mastodon::return_call::return_call </td>
<td>(</td>
<td class="paramtype">const uint8_t&#160;</td>
<td class="paramname"><em>ec</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const string &amp;&#160;</td>
<td class="paramname"><em>em</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint16_t&#160;</td>
<td class="paramname"><em>hec</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const string &amp;&#160;</td>
<td class="paramname"><em>a</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return type for <a class="el" href="classMastodon_1_1API.html" title="Interface to the Mastodon API.">Mastodon::API</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ec</td><td>Error code </td></tr>
<tr><td class="paramname">em</td><td>Error message </td></tr>
<tr><td class="paramname">hec</td><td>HTTP error code </td></tr>
<tr><td class="paramname">a</td><td>Answer</td></tr>
</table>
</dd>
</dl>
<dl class="section since"><dt>Since</dt><dd>0.100.0 </dd></dl>
<div class="fragment"><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; : <a class="code" href="structMastodon_1_1return__call.html#a8d9ac799e26fc5ff54592083a8a83404">answer</a>(a)</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; {</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <a class="code" href="structMastodon_1_1return__base.html#a12cebffae19249cac4c9e4ae9f95391a">error_code</a> = ec;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <a class="code" href="structMastodon_1_1return__base.html#ab902d5ecac698fadbdcabcd99d0ce754">error_message</a> = em;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <a class="code" href="structMastodon_1_1return__base.html#af62546b8b4bb03899ddbec770065e0b6">http_error_code</a> = hec;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; }</div><div class="ttc" id="structMastodon_1_1return__call_html_a8d9ac799e26fc5ff54592083a8a83404"><div class="ttname"><a href="structMastodon_1_1return__call.html#a8d9ac799e26fc5ff54592083a8a83404">Mastodon::return_call::answer</a></div><div class="ttdeci">string answer</div><div class="ttdoc">The response from the server.</div><div class="ttdef"><b>Definition:</b> return_types.hpp:100</div></div>
<div class="ttc" id="structMastodon_1_1return__base_html_a12cebffae19249cac4c9e4ae9f95391a"><div class="ttname"><a href="structMastodon_1_1return__base.html#a12cebffae19249cac4c9e4ae9f95391a">Mastodon::return_base::error_code</a></div><div class="ttdeci">uint8_t error_code</div><div class="ttdoc">Error code.</div><div class="ttdef"><b>Definition:</b> return_types.hpp:42</div></div>
<div class="ttc" id="structMastodon_1_1return__base_html_af62546b8b4bb03899ddbec770065e0b6"><div class="ttname"><a href="structMastodon_1_1return__base.html#af62546b8b4bb03899ddbec770065e0b6">Mastodon::return_base::http_error_code</a></div><div class="ttdeci">uint16_t http_error_code</div><div class="ttdoc">HTTP error code.</div><div class="ttdef"><b>Definition:</b> return_types.hpp:56</div></div>
<div class="ttc" id="structMastodon_1_1return__base_html_ab902d5ecac698fadbdcabcd99d0ce754"><div class="ttname"><a href="structMastodon_1_1return__base.html#ab902d5ecac698fadbdcabcd99d0ce754">Mastodon::return_base::error_message</a></div><div class="ttdeci">string error_message</div><div class="ttdoc">The error message, or &quot;&quot;.</div><div class="ttdef"><b>Definition:</b> return_types.hpp:49</div></div>
</div><!-- fragment -->
</div>
</div>
<a id="a3aafabc74733c8dfeaa81c3f10c5cbe0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3aafabc74733c8dfeaa81c3f10c5cbe0">&#9670;&nbsp;</a></span>return_call() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Mastodon::return_call::return_call </td>
<td>(</td>
<td class="paramtype">const error&#160;</td>
<td class="paramname"><em>ec</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const string &amp;&#160;</td>
<td class="paramname"><em>em</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint16_t&#160;</td>
<td class="paramname"><em>hec</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const string &amp;&#160;</td>
<td class="paramname"><em>a</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return type for <a class="el" href="classMastodon_1_1API.html" title="Interface to the Mastodon API.">Mastodon::API</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ec</td><td>Error code </td></tr>
<tr><td class="paramname">em</td><td>Error message </td></tr>
<tr><td class="paramname">hec</td><td>HTTP error code </td></tr>
<tr><td class="paramname">a</td><td>Answer</td></tr>
</table>
</dd>
</dl>
<dl class="section since"><dt>Since</dt><dd>0.110.0 </dd></dl>
<div class="fragment"><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; : <a class="code" href="structMastodon_1_1return__call.html#a8d9ac799e26fc5ff54592083a8a83404">answer</a>(a)</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; {</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <a class="code" href="structMastodon_1_1return__base.html#a12cebffae19249cac4c9e4ae9f95391a">error_code</a> = static_cast&lt;uint8_t&gt;(ec);</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <a class="code" href="structMastodon_1_1return__base.html#ab902d5ecac698fadbdcabcd99d0ce754">error_message</a> = em;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <a class="code" href="structMastodon_1_1return__base.html#af62546b8b4bb03899ddbec770065e0b6">http_error_code</a> = hec;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; }</div><div class="ttc" id="structMastodon_1_1return__call_html_a8d9ac799e26fc5ff54592083a8a83404"><div class="ttname"><a href="structMastodon_1_1return__call.html#a8d9ac799e26fc5ff54592083a8a83404">Mastodon::return_call::answer</a></div><div class="ttdeci">string answer</div><div class="ttdoc">The response from the server.</div><div class="ttdef"><b>Definition:</b> return_types.hpp:100</div></div>
<div class="ttc" id="structMastodon_1_1return__base_html_a12cebffae19249cac4c9e4ae9f95391a"><div class="ttname"><a href="structMastodon_1_1return__base.html#a12cebffae19249cac4c9e4ae9f95391a">Mastodon::return_base::error_code</a></div><div class="ttdeci">uint8_t error_code</div><div class="ttdoc">Error code.</div><div class="ttdef"><b>Definition:</b> return_types.hpp:42</div></div>
<div class="ttc" id="structMastodon_1_1return__base_html_af62546b8b4bb03899ddbec770065e0b6"><div class="ttname"><a href="structMastodon_1_1return__base.html#af62546b8b4bb03899ddbec770065e0b6">Mastodon::return_base::http_error_code</a></div><div class="ttdeci">uint16_t http_error_code</div><div class="ttdoc">HTTP error code.</div><div class="ttdef"><b>Definition:</b> return_types.hpp:56</div></div>
<div class="ttc" id="structMastodon_1_1return__base_html_ab902d5ecac698fadbdcabcd99d0ce754"><div class="ttname"><a href="structMastodon_1_1return__base.html#ab902d5ecac698fadbdcabcd99d0ce754">Mastodon::return_base::error_message</a></div><div class="ttdeci">string error_message</div><div class="ttdoc">The error message, or &quot;&quot;.</div><div class="ttdef"><b>Definition:</b> return_types.hpp:49</div></div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="af8eed5b7fdb3dac4085e3c74e8ad9f9f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af8eed5b7fdb3dac4085e3c74e8ad9f9f">&#9670;&nbsp;</a></span>operator const string()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Mastodon::return_call::operator const string </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Same es <a class="el" href="structMastodon_1_1return__call.html#a8d9ac799e26fc5ff54592083a8a83404" title="The response from the server.">return_call::answer</a>. </p>
<dl class="section since"><dt>Since</dt><dd>0.100.0 </dd></dl>
<div class="fragment"><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keywordflow">return</span> <a class="code" href="structMastodon_1_1return__call.html#a8d9ac799e26fc5ff54592083a8a83404">answer</a>;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; }</div><div class="ttc" id="structMastodon_1_1return__call_html_a8d9ac799e26fc5ff54592083a8a83404"><div class="ttname"><a href="structMastodon_1_1return__call.html#a8d9ac799e26fc5ff54592083a8a83404">Mastodon::return_call::answer</a></div><div class="ttdeci">string answer</div><div class="ttdoc">The response from the server.</div><div class="ttdef"><b>Definition:</b> return_types.hpp:100</div></div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="a9a83900af66c00acd9c26da38de17af8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9a83900af66c00acd9c26da38de17af8">&#9670;&nbsp;</a></span>operator&lt;&lt;</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::ostream&amp; operator&lt;&lt; </td>
<td>(</td>
<td class="paramtype">std::ostream &amp;&#160;</td>
<td class="paramname"><em>out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structMastodon_1_1return__call.html">return_call</a> &amp;&#160;</td>
<td class="paramname"><em>ret</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">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Same es <a class="el" href="structMastodon_1_1return__call.html#a8d9ac799e26fc5ff54592083a8a83404" title="The response from the server.">return_call::answer</a>. </p>
<dl class="section since"><dt>Since</dt><dd>0.100.0 </dd></dl>
<div class="fragment"><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; {</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; out &lt;&lt; ret.answer;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keywordflow">return</span> out;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; }</div></div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a8d9ac799e26fc5ff54592083a8a83404"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d9ac799e26fc5ff54592083a8a83404">&#9670;&nbsp;</a></span>answer</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string Mastodon::return_call::answer</td>
</tr>
</table>
</div><div class="memdoc">
<p>The response from the server. </p>
<dl class="section since"><dt>Since</dt><dd>0.100.0 </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="example01_get_public_timeline_8cpp-example.html#a4">example01_get_public_timeline.cpp</a>.</dd>
</dl>
</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li>src/<a class="el" href="return__types_8hpp_source.html">return_types.hpp</a></li>
<li>src/return_types.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.15
</small></address>
</body>
</html>