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/classMastodon_1_1Easy_1_1In...

548 lines
61 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::Easy::Instance 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="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="namespaceMastodon_1_1Easy.html">Easy</a></li><li class="navelem"><a class="el" href="classMastodon_1_1Easy_1_1Instance.html">Instance</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classMastodon_1_1Easy_1_1Instance-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Mastodon::Easy::Instance Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Class to hold instances.
<a href="classMastodon_1_1Easy_1_1Instance.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="instance_8hpp_source.html">instance.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for Mastodon::Easy::Instance:</div>
<div class="dyncontent">
<div class="center">
<img src="classMastodon_1_1Easy_1_1Instance.png" usemap="#Mastodon::Easy::Instance_map" alt=""/>
<map id="Mastodon::Easy::Instance_map" name="Mastodon::Easy::Instance_map">
<area href="classMastodon_1_1Easy_1_1Entity.html" title="Base class for all entities." alt="Mastodon::Easy::Entity" shape="rect" coords="0,0,154,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:a22141e6d58a5dfdf15a36dfe5430cb0b"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Instance.html#a22141e6d58a5dfdf15a36dfe5430cb0b">valid</a> () const override</td></tr>
<tr class="memdesc:a22141e6d58a5dfdf15a36dfe5430cb0b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the <a class="el" href="classMastodon_1_1Easy_1_1Entity.html" title="Base class for all entities.">Entity</a> holds valid data. <a href="#a22141e6d58a5dfdf15a36dfe5430cb0b">More...</a><br /></td></tr>
<tr class="separator:a22141e6d58a5dfdf15a36dfe5430cb0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad64fce6e6d2f9bd163982427ef898292"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classMastodon_1_1Easy_1_1Account.html">Account</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Instance.html#ad64fce6e6d2f9bd163982427ef898292">contact_account</a> () const</td></tr>
<tr class="memdesc:ad64fce6e6d2f9bd163982427ef898292"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the <a class="el" href="classMastodon_1_1Easy_1_1Account.html" title="Class to hold accounts.">Account</a> of the admin or another contact person. <a href="#ad64fce6e6d2f9bd163982427ef898292">More...</a><br /></td></tr>
<tr class="separator:ad64fce6e6d2f9bd163982427ef898292"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a88c0adac4c861936a9eaa77514dfc663"><td class="memItemLeft" align="right" valign="top">const string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Instance.html#a88c0adac4c861936a9eaa77514dfc663">description</a> () const</td></tr>
<tr class="memdesc:a88c0adac4c861936a9eaa77514dfc663"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the description of the instance. <a href="#a88c0adac4c861936a9eaa77514dfc663">More...</a><br /></td></tr>
<tr class="separator:a88c0adac4c861936a9eaa77514dfc663"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ae503d864ac04669520d1be8da3aeb4"><td class="memItemLeft" align="right" valign="top">const string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Instance.html#a9ae503d864ac04669520d1be8da3aeb4">email</a> () const</td></tr>
<tr class="memdesc:a9ae503d864ac04669520d1be8da3aeb4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the email address which can be used to contact the instance administrator. <a href="#a9ae503d864ac04669520d1be8da3aeb4">More...</a><br /></td></tr>
<tr class="separator:a9ae503d864ac04669520d1be8da3aeb4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aebfa2f19d09cbc83aec06f414bc3bcbb"><td class="memItemLeft" align="right" valign="top">const vector&lt; string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Instance.html#aebfa2f19d09cbc83aec06f414bc3bcbb">languages</a> () const</td></tr>
<tr class="memdesc:aebfa2f19d09cbc83aec06f414bc3bcbb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a vector of ISO 6391 language codes the instance has chosen to advertise. <a href="#aebfa2f19d09cbc83aec06f414bc3bcbb">More...</a><br /></td></tr>
<tr class="separator:aebfa2f19d09cbc83aec06f414bc3bcbb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8df717fc6dfa55f47f02c42800d9e6e6"><td class="memItemLeft" align="right" valign="top">const string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Instance.html#a8df717fc6dfa55f47f02c42800d9e6e6">thumbnail</a> () const</td></tr>
<tr class="memdesc:a8df717fc6dfa55f47f02c42800d9e6e6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the thumbnail of the instance. <a href="#a8df717fc6dfa55f47f02c42800d9e6e6">More...</a><br /></td></tr>
<tr class="separator:a8df717fc6dfa55f47f02c42800d9e6e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb7508b6348d12d1187b70d19643b15a"><td class="memItemLeft" align="right" valign="top">const string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Instance.html#acb7508b6348d12d1187b70d19643b15a">title</a> () const</td></tr>
<tr class="memdesc:acb7508b6348d12d1187b70d19643b15a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the title of the instance. <a href="#acb7508b6348d12d1187b70d19643b15a">More...</a><br /></td></tr>
<tr class="separator:acb7508b6348d12d1187b70d19643b15a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af967f5933e097c6a449d291ac16043c1"><td class="memItemLeft" align="right" valign="top">const string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Instance.html#af967f5933e097c6a449d291ac16043c1">uri</a> () const</td></tr>
<tr class="memdesc:af967f5933e097c6a449d291ac16043c1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the URI of the instance. <a href="#af967f5933e097c6a449d291ac16043c1">More...</a><br /></td></tr>
<tr class="separator:af967f5933e097c6a449d291ac16043c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a43fc90dc117f65ea640e1d4df36460"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structMastodon_1_1Easy_1_1urls__type.html">Easy::urls_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Instance.html#a4a43fc90dc117f65ea640e1d4df36460">urls</a> () const</td></tr>
<tr class="memdesc:a4a43fc90dc117f65ea640e1d4df36460"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the URL for the streaming <a class="el" href="classMastodon_1_1Easy_1_1API.html" title="Child of Mastodon::API with abstract methods.">API</a> and possibly others. <a href="#a4a43fc90dc117f65ea640e1d4df36460">More...</a><br /></td></tr>
<tr class="separator:a4a43fc90dc117f65ea640e1d4df36460"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab482669c1643bc362fe14ed1deb91c8c"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structMastodon_1_1Easy_1_1stats__type.html">Easy::stats_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Instance.html#ab482669c1643bc362fe14ed1deb91c8c">stats</a> () const</td></tr>
<tr class="memdesc:ab482669c1643bc362fe14ed1deb91c8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns statistics about the instance. <a href="#ab482669c1643bc362fe14ed1deb91c8c">More...</a><br /></td></tr>
<tr class="separator:ab482669c1643bc362fe14ed1deb91c8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0a0c2656943c60f490d18894e4806c7f"><td class="memItemLeft" align="right" valign="top">const string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Instance.html#a0a0c2656943c60f490d18894e4806c7f">version</a> () const</td></tr>
<tr class="memdesc:a0a0c2656943c60f490d18894e4806c7f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the version used by the instance. <a href="#a0a0c2656943c60f490d18894e4806c7f">More...</a><br /></td></tr>
<tr class="separator:a0a0c2656943c60f490d18894e4806c7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aab07d99500d330c0a28b3778f254febe"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Instance.html#aab07d99500d330c0a28b3778f254febe">max_toot_chars</a> () const</td></tr>
<tr class="memdesc:aab07d99500d330c0a28b3778f254febe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the maximum chars a post can have. <a href="#aab07d99500d330c0a28b3778f254febe">More...</a><br /></td></tr>
<tr class="separator:aab07d99500d330c0a28b3778f254febe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a753b382e29be6cb7b16772d4c609cedc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Instance.html#a753b382e29be6cb7b16772d4c609cedc">Entity</a> (const string &amp;json)</td></tr>
<tr class="memdesc:a753b382e29be6cb7b16772d4c609cedc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an <a class="el" href="classMastodon_1_1Easy_1_1Entity.html" title="Base class for all entities.">Entity</a> object from a JSON string. <a href="#a753b382e29be6cb7b16772d4c609cedc">More...</a><br /></td></tr>
<tr class="separator:a753b382e29be6cb7b16772d4c609cedc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f75930d233df7d2bc04629ba00a139d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Instance.html#a2f75930d233df7d2bc04629ba00a139d">Entity</a> (const Json::Value &amp;object)</td></tr>
<tr class="memdesc:a2f75930d233df7d2bc04629ba00a139d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an <a class="el" href="classMastodon_1_1Easy_1_1Entity.html" title="Base class for all entities.">Entity</a> object from a JSON object. <a href="#a2f75930d233df7d2bc04629ba00a139d">More...</a><br /></td></tr>
<tr class="separator:a2f75930d233df7d2bc04629ba00a139d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a83eb2be5a13eaaa22b2796f05817f7a9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Instance.html#a83eb2be5a13eaaa22b2796f05817f7a9">Entity</a> ()</td></tr>
<tr class="memdesc:a83eb2be5a13eaaa22b2796f05817f7a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an empty <a class="el" href="classMastodon_1_1Easy_1_1Entity.html" title="Base class for all entities.">Entity</a> object. <a href="#a83eb2be5a13eaaa22b2796f05817f7a9">More...</a><br /></td></tr>
<tr class="separator:a83eb2be5a13eaaa22b2796f05817f7a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classMastodon_1_1Easy_1_1Entity"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classMastodon_1_1Easy_1_1Entity')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classMastodon_1_1Easy_1_1Entity.html">Mastodon::Easy::Entity</a></td></tr>
<tr class="memitem:a753b382e29be6cb7b16772d4c609cedc inherit pub_methods_classMastodon_1_1Easy_1_1Entity"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Entity.html#a753b382e29be6cb7b16772d4c609cedc">Entity</a> (const string &amp;json)</td></tr>
<tr class="memdesc:a753b382e29be6cb7b16772d4c609cedc inherit pub_methods_classMastodon_1_1Easy_1_1Entity"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an <a class="el" href="classMastodon_1_1Easy_1_1Entity.html" title="Base class for all entities.">Entity</a> object from a JSON string. <a href="classMastodon_1_1Easy_1_1Entity.html#a753b382e29be6cb7b16772d4c609cedc">More...</a><br /></td></tr>
<tr class="separator:a753b382e29be6cb7b16772d4c609cedc inherit pub_methods_classMastodon_1_1Easy_1_1Entity"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f75930d233df7d2bc04629ba00a139d inherit pub_methods_classMastodon_1_1Easy_1_1Entity"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Entity.html#a2f75930d233df7d2bc04629ba00a139d">Entity</a> (const Json::Value &amp;object)</td></tr>
<tr class="memdesc:a2f75930d233df7d2bc04629ba00a139d inherit pub_methods_classMastodon_1_1Easy_1_1Entity"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an <a class="el" href="classMastodon_1_1Easy_1_1Entity.html" title="Base class for all entities.">Entity</a> object from a JSON object. <a href="classMastodon_1_1Easy_1_1Entity.html#a2f75930d233df7d2bc04629ba00a139d">More...</a><br /></td></tr>
<tr class="separator:a2f75930d233df7d2bc04629ba00a139d inherit pub_methods_classMastodon_1_1Easy_1_1Entity"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a83eb2be5a13eaaa22b2796f05817f7a9 inherit pub_methods_classMastodon_1_1Easy_1_1Entity"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Entity.html#a83eb2be5a13eaaa22b2796f05817f7a9">Entity</a> ()</td></tr>
<tr class="memdesc:a83eb2be5a13eaaa22b2796f05817f7a9 inherit pub_methods_classMastodon_1_1Easy_1_1Entity"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an empty <a class="el" href="classMastodon_1_1Easy_1_1Entity.html" title="Base class for all entities.">Entity</a> object. <a href="classMastodon_1_1Easy_1_1Entity.html#a83eb2be5a13eaaa22b2796f05817f7a9">More...</a><br /></td></tr>
<tr class="separator:a83eb2be5a13eaaa22b2796f05817f7a9 inherit pub_methods_classMastodon_1_1Easy_1_1Entity"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5d6464e9bb1fccd4e8b677f30a655f19 inherit pub_methods_classMastodon_1_1Easy_1_1Entity"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Entity.html#a5d6464e9bb1fccd4e8b677f30a655f19">~Entity</a> ()</td></tr>
<tr class="memdesc:a5d6464e9bb1fccd4e8b677f30a655f19 inherit pub_methods_classMastodon_1_1Easy_1_1Entity"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys the object. <a href="classMastodon_1_1Easy_1_1Entity.html#a5d6464e9bb1fccd4e8b677f30a655f19">More...</a><br /></td></tr>
<tr class="separator:a5d6464e9bb1fccd4e8b677f30a655f19 inherit pub_methods_classMastodon_1_1Easy_1_1Entity"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f81e1e98c1780ac23bea646122f4bba inherit pub_methods_classMastodon_1_1Easy_1_1Entity"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Entity.html#a8f81e1e98c1780ac23bea646122f4bba">operator const Json::Value</a> () const</td></tr>
<tr class="separator:a8f81e1e98c1780ac23bea646122f4bba inherit pub_methods_classMastodon_1_1Easy_1_1Entity"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a16d99717df650d00312509b79de70a60 inherit pub_methods_classMastodon_1_1Easy_1_1Entity"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Entity.html#a16d99717df650d00312509b79de70a60">from_string</a> (const string &amp;json)</td></tr>
<tr class="memdesc:a16d99717df650d00312509b79de70a60 inherit pub_methods_classMastodon_1_1Easy_1_1Entity"><td class="mdescLeft">&#160;</td><td class="mdescRight">Replaces the <a class="el" href="classMastodon_1_1Easy_1_1Entity.html" title="Base class for all entities.">Entity</a> with a new one from a JSON string. <a href="classMastodon_1_1Easy_1_1Entity.html#a16d99717df650d00312509b79de70a60">More...</a><br /></td></tr>
<tr class="separator:a16d99717df650d00312509b79de70a60 inherit pub_methods_classMastodon_1_1Easy_1_1Entity"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7482a8784b8ce80a0f534e23c8d9cceb inherit pub_methods_classMastodon_1_1Easy_1_1Entity"><td class="memItemLeft" align="right" valign="top">const string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Entity.html#a7482a8784b8ce80a0f534e23c8d9cceb">to_string</a> () const</td></tr>
<tr class="memdesc:a7482a8784b8ce80a0f534e23c8d9cceb inherit pub_methods_classMastodon_1_1Easy_1_1Entity"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the JSON of the <a class="el" href="classMastodon_1_1Easy_1_1Entity.html" title="Base class for all entities.">Entity</a> as formatted string. <a href="classMastodon_1_1Easy_1_1Entity.html#a7482a8784b8ce80a0f534e23c8d9cceb">More...</a><br /></td></tr>
<tr class="separator:a7482a8784b8ce80a0f534e23c8d9cceb inherit pub_methods_classMastodon_1_1Easy_1_1Entity"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a036816325ebd642c096eaf862d746db3 inherit pub_methods_classMastodon_1_1Easy_1_1Entity"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Entity.html#a036816325ebd642c096eaf862d746db3">from_object</a> (const Json::Value &amp;object)</td></tr>
<tr class="memdesc:a036816325ebd642c096eaf862d746db3 inherit pub_methods_classMastodon_1_1Easy_1_1Entity"><td class="mdescLeft">&#160;</td><td class="mdescRight">Replaces the <a class="el" href="classMastodon_1_1Easy_1_1Entity.html" title="Base class for all entities.">Entity</a> with a new one from a JSON object. <a href="classMastodon_1_1Easy_1_1Entity.html#a036816325ebd642c096eaf862d746db3">More...</a><br /></td></tr>
<tr class="separator:a036816325ebd642c096eaf862d746db3 inherit pub_methods_classMastodon_1_1Easy_1_1Entity"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab9ed99f52a6337b04a506e8b30b37dd9 inherit pub_methods_classMastodon_1_1Easy_1_1Entity"><td class="memItemLeft" align="right" valign="top">const Json::Value&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Entity.html#ab9ed99f52a6337b04a506e8b30b37dd9">to_object</a> () const</td></tr>
<tr class="memdesc:ab9ed99f52a6337b04a506e8b30b37dd9 inherit pub_methods_classMastodon_1_1Easy_1_1Entity"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the JSON object of the <a class="el" href="classMastodon_1_1Easy_1_1Entity.html" title="Base class for all entities.">Entity</a>. <a href="classMastodon_1_1Easy_1_1Entity.html#ab9ed99f52a6337b04a506e8b30b37dd9">More...</a><br /></td></tr>
<tr class="separator:ab9ed99f52a6337b04a506e8b30b37dd9 inherit pub_methods_classMastodon_1_1Easy_1_1Entity"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a15066ab4c090dd52b08b7c410b14e181 inherit pub_methods_classMastodon_1_1Easy_1_1Entity"><td class="memItemLeft" align="right" valign="top">const string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Entity.html#a15066ab4c090dd52b08b7c410b14e181">error</a> () const</td></tr>
<tr class="memdesc:a15066ab4c090dd52b08b7c410b14e181 inherit pub_methods_classMastodon_1_1Easy_1_1Entity"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns error string sent by the server. <a href="classMastodon_1_1Easy_1_1Entity.html#a15066ab4c090dd52b08b7c410b14e181">More...</a><br /></td></tr>
<tr class="separator:a15066ab4c090dd52b08b7c410b14e181 inherit pub_methods_classMastodon_1_1Easy_1_1Entity"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d8e026d50315925f6824e0f6c58df36 inherit pub_methods_classMastodon_1_1Easy_1_1Entity"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Entity.html#a9d8e026d50315925f6824e0f6c58df36">was_set</a> () const</td></tr>
<tr class="memdesc:a9d8e026d50315925f6824e0f6c58df36 inherit pub_methods_classMastodon_1_1Easy_1_1Entity"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the last requested value was set, false if it was unset. <a href="classMastodon_1_1Easy_1_1Entity.html#a9d8e026d50315925f6824e0f6c58df36">More...</a><br /></td></tr>
<tr class="separator:a9d8e026d50315925f6824e0f6c58df36 inherit pub_methods_classMastodon_1_1Easy_1_1Entity"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_classMastodon_1_1Easy_1_1Entity"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classMastodon_1_1Easy_1_1Entity')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classMastodon_1_1Easy_1_1Entity.html">Mastodon::Easy::Entity</a></td></tr>
<tr class="memitem:a34f71a5cf80f966660ce032566c4521b inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="memItemLeft" align="right" valign="top">const Json::Value&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Entity.html#a34f71a5cf80f966660ce032566c4521b">get</a> (const string &amp;key) const</td></tr>
<tr class="memdesc:a34f71a5cf80f966660ce032566c4521b inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the value of key as Json::Value. <a href="classMastodon_1_1Easy_1_1Entity.html#a34f71a5cf80f966660ce032566c4521b">More...</a><br /></td></tr>
<tr class="separator:a34f71a5cf80f966660ce032566c4521b inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adb8d99a42bce94868a5bd68937cc1e93 inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="memItemLeft" align="right" valign="top">const string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Entity.html#adb8d99a42bce94868a5bd68937cc1e93">get_string</a> (const string &amp;key) const</td></tr>
<tr class="memdesc:adb8d99a42bce94868a5bd68937cc1e93 inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the value of key as std::string. <a href="classMastodon_1_1Easy_1_1Entity.html#adb8d99a42bce94868a5bd68937cc1e93">More...</a><br /></td></tr>
<tr class="separator:adb8d99a42bce94868a5bd68937cc1e93 inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad27a6fe68b96e187ed29d5260e52e32b inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Entity.html#ad27a6fe68b96e187ed29d5260e52e32b">get_uint64</a> (const string &amp;key) const</td></tr>
<tr class="memdesc:ad27a6fe68b96e187ed29d5260e52e32b inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the value of key as std::uint64_t. <a href="classMastodon_1_1Easy_1_1Entity.html#ad27a6fe68b96e187ed29d5260e52e32b">More...</a><br /></td></tr>
<tr class="separator:ad27a6fe68b96e187ed29d5260e52e32b inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6082153efde52b69b1b88372d268554f inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Entity.html#a6082153efde52b69b1b88372d268554f">get_double</a> (const string &amp;key) const</td></tr>
<tr class="memdesc:a6082153efde52b69b1b88372d268554f inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the value of key as double. <a href="classMastodon_1_1Easy_1_1Entity.html#a6082153efde52b69b1b88372d268554f">More...</a><br /></td></tr>
<tr class="separator:a6082153efde52b69b1b88372d268554f inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10c3fde7a0941c679eec4ae7539aa421 inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Entity.html#a10c3fde7a0941c679eec4ae7539aa421">get_bool</a> (const string &amp;key) const</td></tr>
<tr class="memdesc:a10c3fde7a0941c679eec4ae7539aa421 inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the value of key as bool. <a href="classMastodon_1_1Easy_1_1Entity.html#a10c3fde7a0941c679eec4ae7539aa421">More...</a><br /></td></tr>
<tr class="separator:a10c3fde7a0941c679eec4ae7539aa421 inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aab557dc44a715065d9a10331a984f7c0 inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structMastodon_1_1Easy_1_1time__type.html">Easy::time_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Entity.html#aab557dc44a715065d9a10331a984f7c0">get_time</a> (const string &amp;key) const</td></tr>
<tr class="memdesc:aab557dc44a715065d9a10331a984f7c0 inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the value of key as Easy::time. <a href="classMastodon_1_1Easy_1_1Entity.html#aab557dc44a715065d9a10331a984f7c0">More...</a><br /></td></tr>
<tr class="separator:aab557dc44a715065d9a10331a984f7c0 inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a00f1106c4143e070207b0a96ba736042 inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="memItemLeft" align="right" valign="top">const std::vector&lt; string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Entity.html#a00f1106c4143e070207b0a96ba736042">get_vector</a> (const string &amp;key) const</td></tr>
<tr class="memdesc:a00f1106c4143e070207b0a96ba736042 inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the value of key as vector. <a href="classMastodon_1_1Easy_1_1Entity.html#a00f1106c4143e070207b0a96ba736042">More...</a><br /></td></tr>
<tr class="separator:a00f1106c4143e070207b0a96ba736042 inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a598cb356c85af698e6e5390a12d39e6a inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Entity.html#a598cb356c85af698e6e5390a12d39e6a">set</a> (const string &amp;key, const Json::Value &amp;value)</td></tr>
<tr class="memdesc:a598cb356c85af698e6e5390a12d39e6a inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the value of key. <a href="classMastodon_1_1Easy_1_1Entity.html#a598cb356c85af698e6e5390a12d39e6a">More...</a><br /></td></tr>
<tr class="separator:a598cb356c85af698e6e5390a12d39e6a inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc71e78fbc381dddfc838e09318d4de8 inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="memItemLeft" align="right" valign="top"><a id="adc71e78fbc381dddfc838e09318d4de8"></a>
std::uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Entity.html#adc71e78fbc381dddfc838e09318d4de8">stouint64</a> (const string &amp;str) const</td></tr>
<tr class="memdesc:adc71e78fbc381dddfc838e09318d4de8 inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns value of str as uint64_t. <br /></td></tr>
<tr class="separator:adc71e78fbc381dddfc838e09318d4de8 inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9af50e48d1241e0c2f32b2032312cfef inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Entity.html#a9af50e48d1241e0c2f32b2032312cfef">check_valid</a> (const std::vector&lt; string &gt; &amp;attributes) const</td></tr>
<tr class="memdesc:a9af50e48d1241e0c2f32b2032312cfef inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if an <a class="el" href="classMastodon_1_1Easy_1_1Entity.html" title="Base class for all entities.">Entity</a> is valid. <a href="classMastodon_1_1Easy_1_1Entity.html#a9af50e48d1241e0c2f32b2032312cfef">More...</a><br /></td></tr>
<tr class="separator:a9af50e48d1241e0c2f32b2032312cfef inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><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>Class to hold instances. </p>
<dl class="section since"><dt>Since</dt><dd>before 0.11.0 </dd></dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ad64fce6e6d2f9bd163982427ef898292"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad64fce6e6d2f9bd163982427ef898292">&#9670;&nbsp;</a></span>contact_account()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classMastodon_1_1Easy_1_1Account.html">Easy::Account</a> Instance::contact_account </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the <a class="el" href="classMastodon_1_1Easy_1_1Account.html" title="Class to hold accounts.">Account</a> of the admin or another contact person. </p>
<dl class="section since"><dt>Since</dt><dd>before 0.11.0 </dd></dl>
<div class="fragment"><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;{</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keyword">const</span> Json::Value node = <a class="code" href="classMastodon_1_1Easy_1_1Entity.html#a34f71a5cf80f966660ce032566c4521b">get</a>(<span class="stringliteral">&quot;contact_account&quot;</span>);</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordflow">if</span> (node.isObject())</div><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; <span class="keywordflow">return</span> <a class="code" href="classMastodon_1_1Easy_1_1Account.html">Easy::Account</a>(node);</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; }</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classMastodon_1_1Easy_1_1Account.html">Easy::Account</a>();</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;}</div><div class="ttc" id="classMastodon_1_1Easy_1_1Entity_html_a34f71a5cf80f966660ce032566c4521b"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Entity.html#a34f71a5cf80f966660ce032566c4521b">Mastodon::Easy::Entity::get</a></div><div class="ttdeci">const Json::Value get(const string &amp;key) const</div><div class="ttdoc">Returns the value of key as Json::Value.</div><div class="ttdef"><b>Definition:</b> entity.cpp:133</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Account_html"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Account.html">Mastodon::Easy::Account</a></div><div class="ttdoc">Class to hold accounts.</div><div class="ttdef"><b>Definition:</b> account.hpp:42</div></div>
</div><!-- fragment -->
</div>
</div>
<a id="a88c0adac4c861936a9eaa77514dfc663"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a88c0adac4c861936a9eaa77514dfc663">&#9670;&nbsp;</a></span>description()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const string Instance::description </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the description of the instance. </p>
<dl class="section since"><dt>Since</dt><dd>before 0.11.0 </dd></dl>
<div class="fragment"><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;{</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classMastodon_1_1Easy_1_1Entity.html#adb8d99a42bce94868a5bd68937cc1e93">get_string</a>(<span class="stringliteral">&quot;description&quot;</span>);</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;}</div><div class="ttc" id="classMastodon_1_1Easy_1_1Entity_html_adb8d99a42bce94868a5bd68937cc1e93"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Entity.html#adb8d99a42bce94868a5bd68937cc1e93">Mastodon::Easy::Entity::get_string</a></div><div class="ttdeci">const string get_string(const string &amp;key) const</div><div class="ttdoc">Returns the value of key as std::string.</div><div class="ttdef"><b>Definition:</b> entity.cpp:174</div></div>
</div><!-- fragment -->
</div>
</div>
<a id="a9ae503d864ac04669520d1be8da3aeb4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9ae503d864ac04669520d1be8da3aeb4">&#9670;&nbsp;</a></span>email()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const string Instance::email </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the email address which can be used to contact the instance administrator. </p>
<dl class="section since"><dt>Since</dt><dd>before 0.11.0 </dd></dl>
<div class="fragment"><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;{</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classMastodon_1_1Easy_1_1Entity.html#adb8d99a42bce94868a5bd68937cc1e93">get_string</a>(<span class="stringliteral">&quot;email&quot;</span>);</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;}</div><div class="ttc" id="classMastodon_1_1Easy_1_1Entity_html_adb8d99a42bce94868a5bd68937cc1e93"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Entity.html#adb8d99a42bce94868a5bd68937cc1e93">Mastodon::Easy::Entity::get_string</a></div><div class="ttdeci">const string get_string(const string &amp;key) const</div><div class="ttdoc">Returns the value of key as std::string.</div><div class="ttdef"><b>Definition:</b> entity.cpp:174</div></div>
</div><!-- fragment -->
</div>
</div>
<a id="a83eb2be5a13eaaa22b2796f05817f7a9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a83eb2be5a13eaaa22b2796f05817f7a9">&#9670;&nbsp;</a></span>Entity() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Easy::Entity::Entity</td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs an empty <a class="el" href="classMastodon_1_1Easy_1_1Entity.html" title="Base class for all entities.">Entity</a> object. </p>
<dl class="section since"><dt>Since</dt><dd>before 0.11.0 </dd></dl>
<div class="fragment"><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;: _tree(Json::nullValue)</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;, _was_set(<span class="keyword">false</span>)</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;{}</div></div><!-- fragment -->
</div>
</div>
<a id="a753b382e29be6cb7b16772d4c609cedc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a753b382e29be6cb7b16772d4c609cedc">&#9670;&nbsp;</a></span>Entity() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Easy::Entity::Entity</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="classMastodon_1_1Easy_1_1Entity.html" title="Base class for all entities.">Entity</a> object from a JSON string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">json</td><td>JSON string</td></tr>
</table>
</dd>
</dl>
<dl class="section since"><dt>Since</dt><dd>before 0.11.0 </dd></dl>
<div class="fragment"><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;: _tree(Json::nullValue)</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;,_was_set(<span class="keyword">false</span>)</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; <a class="code" href="classMastodon_1_1Easy_1_1Entity.html#a16d99717df650d00312509b79de70a60">from_string</a>(json);</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;}</div><div class="ttc" id="classMastodon_1_1Easy_1_1Entity_html_a16d99717df650d00312509b79de70a60"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Entity.html#a16d99717df650d00312509b79de70a60">Mastodon::Easy::Entity::from_string</a></div><div class="ttdeci">void from_string(const string &amp;json)</div><div class="ttdoc">Replaces the Entity with a new one from a JSON string.</div><div class="ttdef"><b>Definition:</b> entity.cpp:56</div></div>
</div><!-- fragment -->
</div>
</div>
<a id="a2f75930d233df7d2bc04629ba00a139d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f75930d233df7d2bc04629ba00a139d">&#9670;&nbsp;</a></span>Entity() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Easy::Entity::Entity</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="classMastodon_1_1Easy_1_1Entity.html" title="Base class for all entities.">Entity</a> object from a JSON object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">object</td><td>JSON object</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="l00039"></a><span class="lineno"> 39</span>&#160;: _tree(<span class="keywordtype">object</span>)</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;,_was_set(<span class="keyword">false</span>)</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;{}</div></div><!-- fragment -->
</div>
</div>
<a id="aebfa2f19d09cbc83aec06f414bc3bcbb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aebfa2f19d09cbc83aec06f414bc3bcbb">&#9670;&nbsp;</a></span>languages()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::vector&lt; string &gt; Instance::languages </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a vector of ISO 6391 language codes the instance has chosen to advertise. </p>
<dl class="section since"><dt>Since</dt><dd>before 0.11.0 </dd></dl>
<div class="fragment"><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;{</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classMastodon_1_1Easy_1_1Entity.html#a00f1106c4143e070207b0a96ba736042">get_vector</a>(<span class="stringliteral">&quot;languages&quot;</span>);</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;}</div><div class="ttc" id="classMastodon_1_1Easy_1_1Entity_html_a00f1106c4143e070207b0a96ba736042"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Entity.html#a00f1106c4143e070207b0a96ba736042">Mastodon::Easy::Entity::get_vector</a></div><div class="ttdeci">const std::vector&lt; string &gt; get_vector(const string &amp;key) const</div><div class="ttdoc">Returns the value of key as vector.</div><div class="ttdef"><b>Definition:</b> entity.cpp:245</div></div>
</div><!-- fragment -->
</div>
</div>
<a id="aab07d99500d330c0a28b3778f254febe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aab07d99500d330c0a28b3778f254febe">&#9670;&nbsp;</a></span>max_toot_chars()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t Instance::max_toot_chars </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the maximum chars a post can have. </p>
<pre class="fragment"> This parameter is not supported by upstream Mastodon. If it
is not found, 500 is returned.
</pre><dl class="section since"><dt>Since</dt><dd>0.20.0 </dd></dl>
<div class="fragment"><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;{</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <span class="keyword">const</span> uint64_t max_chars = <a class="code" href="classMastodon_1_1Easy_1_1Entity.html#ad27a6fe68b96e187ed29d5260e52e32b">get_uint64</a>(<span class="stringliteral">&quot;max_toot_chars&quot;</span>);</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <span class="keywordflow">if</span> (<a class="code" href="classMastodon_1_1Easy_1_1Entity.html#a9d8e026d50315925f6824e0f6c58df36">was_set</a>())</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; {</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; <span class="keywordflow">return</span> max_chars;</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; }</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; <span class="keywordflow">else</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; {</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <span class="keywordflow">return</span> 500;</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; }</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;}</div><div class="ttc" id="classMastodon_1_1Easy_1_1Entity_html_ad27a6fe68b96e187ed29d5260e52e32b"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Entity.html#ad27a6fe68b96e187ed29d5260e52e32b">Mastodon::Easy::Entity::get_uint64</a></div><div class="ttdeci">uint64_t get_uint64(const string &amp;key) const</div><div class="ttdoc">Returns the value of key as std::uint64_t.</div><div class="ttdef"><b>Definition:</b> entity.cpp:188</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Entity_html_a9d8e026d50315925f6824e0f6c58df36"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Entity.html#a9d8e026d50315925f6824e0f6c58df36">Mastodon::Easy::Entity::was_set</a></div><div class="ttdeci">bool was_set() const</div><div class="ttdoc">Returns true if the last requested value was set, false if it was unset.</div><div class="ttdef"><b>Definition:</b> entity.cpp:128</div></div>
</div><!-- fragment -->
</div>
</div>
<a id="ab482669c1643bc362fe14ed1deb91c8c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab482669c1643bc362fe14ed1deb91c8c">&#9670;&nbsp;</a></span>stats()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structMastodon_1_1Easy_1_1stats__type.html">Easy::stats_type</a> Instance::stats </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns statistics about the instance. </p>
<dl class="section since"><dt>Since</dt><dd>0.106.0 </dd></dl>
<div class="fragment"><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;{</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <a class="code" href="structMastodon_1_1Easy_1_1stats__type.html">Easy::stats_type</a> s;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; s.user_count = <a class="code" href="classMastodon_1_1Easy_1_1Entity.html#ad27a6fe68b96e187ed29d5260e52e32b">get_uint64</a>(<span class="stringliteral">&quot;stats.user_count&quot;</span>);</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; s.status_count = <a class="code" href="classMastodon_1_1Easy_1_1Entity.html#ad27a6fe68b96e187ed29d5260e52e32b">get_uint64</a>(<span class="stringliteral">&quot;stats.status_count&quot;</span>);</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; s.domain_count = <a class="code" href="classMastodon_1_1Easy_1_1Entity.html#ad27a6fe68b96e187ed29d5260e52e32b">get_uint64</a>(<span class="stringliteral">&quot;stats.domain_count&quot;</span>);</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="keywordflow">return</span> s;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;}</div><div class="ttc" id="classMastodon_1_1Easy_1_1Entity_html_ad27a6fe68b96e187ed29d5260e52e32b"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Entity.html#ad27a6fe68b96e187ed29d5260e52e32b">Mastodon::Easy::Entity::get_uint64</a></div><div class="ttdeci">uint64_t get_uint64(const string &amp;key) const</div><div class="ttdoc">Returns the value of key as std::uint64_t.</div><div class="ttdef"><b>Definition:</b> entity.cpp:188</div></div>
<div class="ttc" id="structMastodon_1_1Easy_1_1stats__type_html"><div class="ttname"><a href="structMastodon_1_1Easy_1_1stats__type.html">Mastodon::Easy::stats_type</a></div><div class="ttdoc">Statistics returned by Instance::stats().</div><div class="ttdef"><b>Definition:</b> types_easy.hpp:222</div></div>
</div><!-- fragment -->
</div>
</div>
<a id="a8df717fc6dfa55f47f02c42800d9e6e6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8df717fc6dfa55f47f02c42800d9e6e6">&#9670;&nbsp;</a></span>thumbnail()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const string Instance::thumbnail </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the thumbnail of the instance. </p>
<dl class="section since"><dt>Since</dt><dd>0.106.0 </dd></dl>
<div class="fragment"><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;{</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classMastodon_1_1Easy_1_1Entity.html#adb8d99a42bce94868a5bd68937cc1e93">get_string</a>(<span class="stringliteral">&quot;thumbnail&quot;</span>);</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;}</div><div class="ttc" id="classMastodon_1_1Easy_1_1Entity_html_adb8d99a42bce94868a5bd68937cc1e93"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Entity.html#adb8d99a42bce94868a5bd68937cc1e93">Mastodon::Easy::Entity::get_string</a></div><div class="ttdeci">const string get_string(const string &amp;key) const</div><div class="ttdoc">Returns the value of key as std::string.</div><div class="ttdef"><b>Definition:</b> entity.cpp:174</div></div>
</div><!-- fragment -->
</div>
</div>
<a id="acb7508b6348d12d1187b70d19643b15a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acb7508b6348d12d1187b70d19643b15a">&#9670;&nbsp;</a></span>title()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const string Instance::title </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the title of the instance. </p>
<dl class="section since"><dt>Since</dt><dd>before 0.11.0 </dd></dl>
<div class="fragment"><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;{</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classMastodon_1_1Easy_1_1Entity.html#adb8d99a42bce94868a5bd68937cc1e93">get_string</a>(<span class="stringliteral">&quot;title&quot;</span>);</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;}</div><div class="ttc" id="classMastodon_1_1Easy_1_1Entity_html_adb8d99a42bce94868a5bd68937cc1e93"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Entity.html#adb8d99a42bce94868a5bd68937cc1e93">Mastodon::Easy::Entity::get_string</a></div><div class="ttdeci">const string get_string(const string &amp;key) const</div><div class="ttdoc">Returns the value of key as std::string.</div><div class="ttdef"><b>Definition:</b> entity.cpp:174</div></div>
</div><!-- fragment -->
</div>
</div>
<a id="af967f5933e097c6a449d291ac16043c1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af967f5933e097c6a449d291ac16043c1">&#9670;&nbsp;</a></span>uri()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const string Instance::uri </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the URI of the instance. </p>
<dl class="section since"><dt>Since</dt><dd>before 0.11.0 </dd></dl>
<div class="fragment"><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;{</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classMastodon_1_1Easy_1_1Entity.html#adb8d99a42bce94868a5bd68937cc1e93">get_string</a>(<span class="stringliteral">&quot;uri&quot;</span>);</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;}</div><div class="ttc" id="classMastodon_1_1Easy_1_1Entity_html_adb8d99a42bce94868a5bd68937cc1e93"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Entity.html#adb8d99a42bce94868a5bd68937cc1e93">Mastodon::Easy::Entity::get_string</a></div><div class="ttdeci">const string get_string(const string &amp;key) const</div><div class="ttdoc">Returns the value of key as std::string.</div><div class="ttdef"><b>Definition:</b> entity.cpp:174</div></div>
</div><!-- fragment -->
</div>
</div>
<a id="a4a43fc90dc117f65ea640e1d4df36460"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4a43fc90dc117f65ea640e1d4df36460">&#9670;&nbsp;</a></span>urls()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structMastodon_1_1Easy_1_1urls__type.html">Easy::urls_type</a> Instance::urls </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the URL for the streaming <a class="el" href="classMastodon_1_1Easy_1_1API.html" title="Child of Mastodon::API with abstract methods.">API</a> and possibly others. </p>
<dl class="section since"><dt>Since</dt><dd>0.106.0 </dd></dl>
<div class="fragment"><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;{</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="keywordflow">return</span> { <a class="code" href="classMastodon_1_1Easy_1_1Entity.html#adb8d99a42bce94868a5bd68937cc1e93">get_string</a>(<span class="stringliteral">&quot;urls.streaming_api&quot;</span>) };</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;}</div><div class="ttc" id="classMastodon_1_1Easy_1_1Entity_html_adb8d99a42bce94868a5bd68937cc1e93"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Entity.html#adb8d99a42bce94868a5bd68937cc1e93">Mastodon::Easy::Entity::get_string</a></div><div class="ttdeci">const string get_string(const string &amp;key) const</div><div class="ttdoc">Returns the value of key as std::string.</div><div class="ttdef"><b>Definition:</b> entity.cpp:174</div></div>
</div><!-- fragment -->
</div>
</div>
<a id="a22141e6d58a5dfdf15a36dfe5430cb0b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a22141e6d58a5dfdf15a36dfe5430cb0b">&#9670;&nbsp;</a></span>valid()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Instance::valid </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if the <a class="el" href="classMastodon_1_1Easy_1_1Entity.html" title="Base class for all entities.">Entity</a> holds valid data. </p>
<dl class="section since"><dt>Since</dt><dd>before 0.11.0 (virtual since 0.18.2) </dd></dl>
<p>Implements <a class="el" href="classMastodon_1_1Easy_1_1Entity.html#ab418a0cde7adc0ecb6016dd5499597a6">Mastodon::Easy::Entity</a>.</p>
<div class="fragment"><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;{</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classMastodon_1_1Easy_1_1Entity.html#a9af50e48d1241e0c2f32b2032312cfef">Entity::check_valid</a>(</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; {</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="stringliteral">&quot;uri&quot;</span>,</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="stringliteral">&quot;title&quot;</span>,</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="stringliteral">&quot;description&quot;</span>,</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="stringliteral">&quot;email&quot;</span>,</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="stringliteral">&quot;version&quot;</span>,</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="stringliteral">&quot;urls&quot;</span>,</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="stringliteral">&quot;stats&quot;</span>,</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="stringliteral">&quot;languages&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;}</div><div class="ttc" id="classMastodon_1_1Easy_1_1Entity_html_a9af50e48d1241e0c2f32b2032312cfef"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Entity.html#a9af50e48d1241e0c2f32b2032312cfef">Mastodon::Easy::Entity::check_valid</a></div><div class="ttdeci">bool check_valid(const std::vector&lt; string &gt; &amp;attributes) const</div><div class="ttdoc">Checks if an Entity is valid.</div><div class="ttdef"><b>Definition:</b> entity.cpp:102</div></div>
</div><!-- fragment -->
</div>
</div>
<a id="a0a0c2656943c60f490d18894e4806c7f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0a0c2656943c60f490d18894e4806c7f">&#9670;&nbsp;</a></span>version()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const string Instance::version </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the version used by the instance. </p>
<dl class="section since"><dt>Since</dt><dd>before 0.11.0 </dd></dl>
<div class="fragment"><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;{</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classMastodon_1_1Easy_1_1Entity.html#adb8d99a42bce94868a5bd68937cc1e93">get_string</a>(<span class="stringliteral">&quot;version&quot;</span>);</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;}</div><div class="ttc" id="classMastodon_1_1Easy_1_1Entity_html_adb8d99a42bce94868a5bd68937cc1e93"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Entity.html#adb8d99a42bce94868a5bd68937cc1e93">Mastodon::Easy::Entity::get_string</a></div><div class="ttdeci">const string get_string(const string &amp;key) const</div><div class="ttdoc">Returns the value of key as std::string.</div><div class="ttdef"><b>Definition:</b> entity.cpp:174</div></div>
</div><!-- fragment -->
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/easy/entities/<a class="el" href="instance_8hpp_source.html">instance.hpp</a></li>
<li>src/easy/entities/instance.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>