457 lines
49 KiB
HTML
457 lines
49 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.14"/>
|
|
<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
|
|
 <span id="projectnumber">0.30.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.14 -->
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',false,false,'search.php','Search');
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><b>Mastodon</b></li><li class="navelem"><a class="el" href="classMastodon_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> |
|
|
<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 <<a class="el" href="instance_8hpp_source.html">instance.hpp</a>></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:ad9348d692d1086efacc82628989719a8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Instance.html#ad9348d692d1086efacc82628989719a8">Instance</a> (const string &json)</td></tr>
|
|
<tr class="memdesc:ad9348d692d1086efacc82628989719a8"><td class="mdescLeft"> </td><td class="mdescRight">Constructs an <a class="el" href="classMastodon_1_1Easy_1_1Instance.html" title="Class to hold instances. ">Instance</a> object from a JSON string. <a href="#ad9348d692d1086efacc82628989719a8">More...</a><br /></td></tr>
|
|
<tr class="separator:ad9348d692d1086efacc82628989719a8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a399506c7e75ab9ab78fbc34a25932bbd"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Instance.html#a399506c7e75ab9ab78fbc34a25932bbd">Instance</a> ()</td></tr>
|
|
<tr class="memdesc:a399506c7e75ab9ab78fbc34a25932bbd"><td class="mdescLeft"> </td><td class="mdescRight">Constructs an empty <a class="el" href="classMastodon_1_1Easy_1_1Instance.html" title="Class to hold instances. ">Instance</a> object. <a href="#a399506c7e75ab9ab78fbc34a25932bbd">More...</a><br /></td></tr>
|
|
<tr class="separator:a399506c7e75ab9ab78fbc34a25932bbd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a331d16c9edec4cbdfac7673083d2a909"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Instance.html#a331d16c9edec4cbdfac7673083d2a909">valid</a> () const</td></tr>
|
|
<tr class="memdesc:a331d16c9edec4cbdfac7673083d2a909"><td class="mdescLeft"> </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="#a331d16c9edec4cbdfac7673083d2a909">More...</a><br /></td></tr>
|
|
<tr class="separator:a331d16c9edec4cbdfac7673083d2a909"><td class="memSeparator" colspan="2"> </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> </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"> </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"> </td></tr>
|
|
<tr class="memitem:a88c0adac4c861936a9eaa77514dfc663"><td class="memItemLeft" align="right" valign="top">const string </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"> </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"> </td></tr>
|
|
<tr class="memitem:a9ae503d864ac04669520d1be8da3aeb4"><td class="memItemLeft" align="right" valign="top">const string </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"> </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"> </td></tr>
|
|
<tr class="memitem:aebfa2f19d09cbc83aec06f414bc3bcbb"><td class="memItemLeft" align="right" valign="top">const std::vector< string > </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"> </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"> </td></tr>
|
|
<tr class="memitem:acb7508b6348d12d1187b70d19643b15a"><td class="memItemLeft" align="right" valign="top">const string </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"> </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"> </td></tr>
|
|
<tr class="memitem:af967f5933e097c6a449d291ac16043c1"><td class="memItemLeft" align="right" valign="top">const string </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"> </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"> </td></tr>
|
|
<tr class="memitem:a0a0c2656943c60f490d18894e4806c7f"><td class="memItemLeft" align="right" valign="top">const string </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"> </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"> </td></tr>
|
|
<tr class="memitem:a85232e0d93f32fba932c2652db0ccac9"><td class="memItemLeft" align="right" valign="top">const string </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Instance.html#a85232e0d93f32fba932c2652db0ccac9">streaming_api</a> () const</td></tr>
|
|
<tr class="memdesc:a85232e0d93f32fba932c2652db0ccac9"><td class="mdescLeft"> </td><td class="mdescRight">Returns the URL for the streaming <a class="el" href="classMastodon_1_1API.html" title="Class for the Mastodon API. ">API</a>. <a href="#a85232e0d93f32fba932c2652db0ccac9">More...</a><br /></td></tr>
|
|
<tr class="separator:a85232e0d93f32fba932c2652db0ccac9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3948fc60228f921f88069698fdae1324"><td class="memItemLeft" align="right" valign="top">uint_fast64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Instance.html#a3948fc60228f921f88069698fdae1324">max_toot_chars</a> () const</td></tr>
|
|
<tr class="memdesc:a3948fc60228f921f88069698fdae1324"><td class="mdescLeft"> </td><td class="mdescRight">Returns the maximum chars a post can have. <a href="#a3948fc60228f921f88069698fdae1324">More...</a><br /></td></tr>
|
|
<tr class="separator:a3948fc60228f921f88069698fdae1324"><td class="memSeparator" colspan="2"> </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="-"/> 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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Entity.html#a753b382e29be6cb7b16772d4c609cedc">Entity</a> (const string &json)</td></tr>
|
|
<tr class="memdesc:a753b382e29be6cb7b16772d4c609cedc inherit pub_methods_classMastodon_1_1Easy_1_1Entity"><td class="mdescLeft"> </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"> </td></tr>
|
|
<tr class="memitem:a83eb2be5a13eaaa22b2796f05817f7a9 inherit pub_methods_classMastodon_1_1Easy_1_1Entity"><td class="memItemLeft" align="right" valign="top"> </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"> </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"> </td></tr>
|
|
<tr class="memitem:a16d99717df650d00312509b79de70a60 inherit pub_methods_classMastodon_1_1Easy_1_1Entity"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Entity.html#a16d99717df650d00312509b79de70a60">from_string</a> (const string &json)</td></tr>
|
|
<tr class="memdesc:a16d99717df650d00312509b79de70a60 inherit pub_methods_classMastodon_1_1Easy_1_1Entity"><td class="mdescLeft"> </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"> </td></tr>
|
|
<tr class="memitem:ab9ed99f52a6337b04a506e8b30b37dd9 inherit pub_methods_classMastodon_1_1Easy_1_1Entity"><td class="memItemLeft" align="right" valign="top">const Json::Value </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"> </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"> </td></tr>
|
|
<tr class="memitem:a15066ab4c090dd52b08b7c410b14e181 inherit pub_methods_classMastodon_1_1Easy_1_1Entity"><td class="memItemLeft" align="right" valign="top">const string </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"> </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"> </td></tr>
|
|
<tr class="memitem:a9d8e026d50315925f6824e0f6c58df36 inherit pub_methods_classMastodon_1_1Easy_1_1Entity"><td class="memItemLeft" align="right" valign="top">bool </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"> </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"> </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="-"/> 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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Entity.html#a34f71a5cf80f966660ce032566c4521b">get</a> (const string &key) const</td></tr>
|
|
<tr class="memdesc:a34f71a5cf80f966660ce032566c4521b inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="mdescLeft"> </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"> </td></tr>
|
|
<tr class="memitem:adb8d99a42bce94868a5bd68937cc1e93 inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="memItemLeft" align="right" valign="top">const string </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Entity.html#adb8d99a42bce94868a5bd68937cc1e93">get_string</a> (const string &key) const</td></tr>
|
|
<tr class="memdesc:adb8d99a42bce94868a5bd68937cc1e93 inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="mdescLeft"> </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"> </td></tr>
|
|
<tr class="memitem:a70657872b65f41ac4e9048c6f0dd2060 inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="memItemLeft" align="right" valign="top">uint_fast64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Entity.html#a70657872b65f41ac4e9048c6f0dd2060">get_uint64</a> (const string &key) const</td></tr>
|
|
<tr class="memdesc:a70657872b65f41ac4e9048c6f0dd2060 inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="mdescLeft"> </td><td class="mdescRight">Returns the value of key as std::uint_fast64_t. <a href="classMastodon_1_1Easy_1_1Entity.html#a70657872b65f41ac4e9048c6f0dd2060">More...</a><br /></td></tr>
|
|
<tr class="separator:a70657872b65f41ac4e9048c6f0dd2060 inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6082153efde52b69b1b88372d268554f inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Entity.html#a6082153efde52b69b1b88372d268554f">get_double</a> (const string &key) const</td></tr>
|
|
<tr class="memdesc:a6082153efde52b69b1b88372d268554f inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="mdescLeft"> </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"> </td></tr>
|
|
<tr class="memitem:a10c3fde7a0941c679eec4ae7539aa421 inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Entity.html#a10c3fde7a0941c679eec4ae7539aa421">get_bool</a> (const string &key) const</td></tr>
|
|
<tr class="memdesc:a10c3fde7a0941c679eec4ae7539aa421 inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="mdescLeft"> </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"> </td></tr>
|
|
<tr class="memitem:a07336bdaa1dfe7cad90a1e686562ec0f inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="memItemLeft" align="right" valign="top">const system_clock::time_point </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Entity.html#a07336bdaa1dfe7cad90a1e686562ec0f">get_time_point</a> (const string &key) const</td></tr>
|
|
<tr class="memdesc:a07336bdaa1dfe7cad90a1e686562ec0f inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="mdescLeft"> </td><td class="mdescRight">Returns the value of key as time_point. <a href="classMastodon_1_1Easy_1_1Entity.html#a07336bdaa1dfe7cad90a1e686562ec0f">More...</a><br /></td></tr>
|
|
<tr class="separator:a07336bdaa1dfe7cad90a1e686562ec0f inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a00f1106c4143e070207b0a96ba736042 inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="memItemLeft" align="right" valign="top">const std::vector< string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Entity.html#a00f1106c4143e070207b0a96ba736042">get_vector</a> (const string &key) const</td></tr>
|
|
<tr class="memdesc:a00f1106c4143e070207b0a96ba736042 inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="mdescLeft"> </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"> </td></tr>
|
|
<tr class="memitem:a598cb356c85af698e6e5390a12d39e6a inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Entity.html#a598cb356c85af698e6e5390a12d39e6a">set</a> (const string &key, const Json::Value &value)</td></tr>
|
|
<tr class="memdesc:a598cb356c85af698e6e5390a12d39e6a inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="mdescLeft"> </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"> </td></tr>
|
|
<tr class="memitem:a8012fa97ebeb1fb118cc274b95be99b3 inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="memItemLeft" align="right" valign="top"><a id="a8012fa97ebeb1fb118cc274b95be99b3"></a>
|
|
std::uint_fast64_t </td><td class="memItemRight" valign="bottom"><b>stouint64</b> (const string &str) const</td></tr>
|
|
<tr class="separator:a8012fa97ebeb1fb118cc274b95be99b3 inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9af50e48d1241e0c2f32b2032312cfef inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Entity.html#a9af50e48d1241e0c2f32b2032312cfef">check_valid</a> (const std::vector< string > &attributes) const</td></tr>
|
|
<tr class="memdesc:a9af50e48d1241e0c2f32b2032312cfef inherit pro_methods_classMastodon_1_1Easy_1_1Entity"><td class="mdescLeft"> </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"> </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">Constructor & Destructor Documentation</h2>
|
|
<a id="ad9348d692d1086efacc82628989719a8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad9348d692d1086efacc82628989719a8">◆ </a></span>Instance() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Instance::Instance </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const string & </td>
|
|
<td class="paramname"><em>json</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>Constructs an <a class="el" href="classMastodon_1_1Easy_1_1Instance.html" title="Class to hold instances. ">Instance</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="l00026"></a><span class="lineno"> 26</span> : <a class="code" href="classMastodon_1_1Easy_1_1Entity.html#a83eb2be5a13eaaa22b2796f05817f7a9">Entity</a>(json)</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> {}</div><div class="ttc" id="classMastodon_1_1Easy_1_1Entity_html_a83eb2be5a13eaaa22b2796f05817f7a9"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Entity.html#a83eb2be5a13eaaa22b2796f05817f7a9">Mastodon::Easy::Entity::Entity</a></div><div class="ttdeci">Entity()</div><div class="ttdoc">Constructs an empty Entity object. </div><div class="ttdef"><b>Definition:</b> entity.cpp:65</div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a399506c7e75ab9ab78fbc34a25932bbd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a399506c7e75ab9ab78fbc34a25932bbd">◆ </a></span>Instance() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Instance::Instance </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Constructs an empty <a class="el" href="classMastodon_1_1Easy_1_1Instance.html" title="Class to hold instances. ">Instance</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="l00030"></a><span class="lineno"> 30</span> : <a class="code" href="classMastodon_1_1Easy_1_1Entity.html#a83eb2be5a13eaaa22b2796f05817f7a9">Entity</a>()</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> {}</div><div class="ttc" id="classMastodon_1_1Easy_1_1Entity_html_a83eb2be5a13eaaa22b2796f05817f7a9"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Entity.html#a83eb2be5a13eaaa22b2796f05817f7a9">Mastodon::Easy::Entity::Entity</a></div><div class="ttdeci">Entity()</div><div class="ttdoc">Constructs an empty Entity object. </div><div class="ttdef"><b>Definition:</b> entity.cpp:65</div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="ad64fce6e6d2f9bd163982427ef898292"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad64fce6e6d2f9bd163982427ef898292">◆ </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="l00051"></a><span class="lineno"> 51</span> {</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">const</span> Json::Value node = <span class="keyword">get</span>(<span class="stringliteral">"contact_account"</span>);</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordflow">if</span> (node.isObject())</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  {</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordflow">return</span> <a class="code" href="classMastodon_1_1Easy_1_1Account.html">Easy::Account</a>(node.toStyledString());</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  }</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  ttdebug << <span class="stringliteral">"Could not get data: contact_account\n"</span>;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordflow">return</span> <a class="code" href="classMastodon_1_1Easy_1_1Account.html">Easy::Account</a>();</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> }</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:46</div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a88c0adac4c861936a9eaa77514dfc663"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a88c0adac4c861936a9eaa77514dfc663">◆ </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="l00063"></a><span class="lineno"> 63</span> {</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordflow">return</span> <a class="code" href="classMastodon_1_1Easy_1_1Entity.html#adb8d99a42bce94868a5bd68937cc1e93">get_string</a>(<span class="stringliteral">"description"</span>);</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> }</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 &key) const</div><div class="ttdoc">Returns the value of key as std::string. </div><div class="ttdef"><b>Definition:</b> entity.cpp:134</div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a9ae503d864ac04669520d1be8da3aeb4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9ae503d864ac04669520d1be8da3aeb4">◆ </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="l00068"></a><span class="lineno"> 68</span> {</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordflow">return</span> <a class="code" href="classMastodon_1_1Easy_1_1Entity.html#adb8d99a42bce94868a5bd68937cc1e93">get_string</a>(<span class="stringliteral">"email"</span>);</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> }</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 &key) const</div><div class="ttdoc">Returns the value of key as std::string. </div><div class="ttdef"><b>Definition:</b> entity.cpp:134</div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="aebfa2f19d09cbc83aec06f414bc3bcbb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aebfa2f19d09cbc83aec06f414bc3bcbb">◆ </a></span>languages()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const std::vector< string > 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="l00073"></a><span class="lineno"> 73</span> {</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordflow">return</span> <a class="code" href="classMastodon_1_1Easy_1_1Entity.html#a00f1106c4143e070207b0a96ba736042">get_vector</a>(<span class="stringliteral">"languages"</span>);</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> }</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< string > get_vector(const string &key) const</div><div class="ttdoc">Returns the value of key as vector. </div><div class="ttdef"><b>Definition:</b> entity.cpp:210</div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a3948fc60228f921f88069698fdae1324"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3948fc60228f921f88069698fdae1324">◆ </a></span>max_toot_chars()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint_fast64_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>
|
|
<p>This parameter is not supported by upstream Mastodon. If it is not found, 500 is returned.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>0.20.0 </dd></dl>
|
|
<div class="fragment"><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> {</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keyword">const</span> uint_fast64_t max_chars = <a class="code" href="classMastodon_1_1Easy_1_1Entity.html#a70657872b65f41ac4e9048c6f0dd2060">get_uint64</a>(<span class="stringliteral">"max_toot_chars"</span>);</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <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="l00101"></a><span class="lineno"> 101</span>  {</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keywordflow">return</span> max_chars;</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  }</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keywordflow">else</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  {</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keywordflow">return</span> 500;</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  }</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> }</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:88</div></div>
|
|
<div class="ttc" id="classMastodon_1_1Easy_1_1Entity_html_a70657872b65f41ac4e9048c6f0dd2060"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Entity.html#a70657872b65f41ac4e9048c6f0dd2060">Mastodon::Easy::Entity::get_uint64</a></div><div class="ttdeci">uint_fast64_t get_uint64(const string &key) const</div><div class="ttdoc">Returns the value of key as std::uint_fast64_t. </div><div class="ttdef"><b>Definition:</b> entity.cpp:148</div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a85232e0d93f32fba932c2652db0ccac9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a85232e0d93f32fba932c2652db0ccac9">◆ </a></span>streaming_api()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const string Instance::streaming_api </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_1API.html" title="Class for the Mastodon API. ">API</a>. </p>
|
|
<dl class="section since"><dt>Since</dt><dd>before 0.11.0 </dd></dl>
|
|
<div class="fragment"><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> {</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keywordflow">return</span> <a class="code" href="classMastodon_1_1Easy_1_1Entity.html#adb8d99a42bce94868a5bd68937cc1e93">get_string</a>(<span class="stringliteral">"urls.streaming_api"</span>);</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> }</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 &key) const</div><div class="ttdoc">Returns the value of key as std::string. </div><div class="ttdef"><b>Definition:</b> entity.cpp:134</div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="acb7508b6348d12d1187b70d19643b15a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acb7508b6348d12d1187b70d19643b15a">◆ </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="l00078"></a><span class="lineno"> 78</span> {</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordflow">return</span> <a class="code" href="classMastodon_1_1Easy_1_1Entity.html#adb8d99a42bce94868a5bd68937cc1e93">get_string</a>(<span class="stringliteral">"title"</span>);</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> }</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 &key) const</div><div class="ttdoc">Returns the value of key as std::string. </div><div class="ttdef"><b>Definition:</b> entity.cpp:134</div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="af967f5933e097c6a449d291ac16043c1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af967f5933e097c6a449d291ac16043c1">◆ </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="l00083"></a><span class="lineno"> 83</span> {</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordflow">return</span> <a class="code" href="classMastodon_1_1Easy_1_1Entity.html#adb8d99a42bce94868a5bd68937cc1e93">get_string</a>(<span class="stringliteral">"uri"</span>);</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> }</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 &key) const</div><div class="ttdoc">Returns the value of key as std::string. </div><div class="ttdef"><b>Definition:</b> entity.cpp:134</div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a331d16c9edec4cbdfac7673083d2a909"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a331d16c9edec4cbdfac7673083d2a909">◆ </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">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="l00034"></a><span class="lineno"> 34</span> {</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keyword">const</span> std::vector<string> attributes =</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  {{</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="stringliteral">"uri"</span>,</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="stringliteral">"title"</span>,</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="stringliteral">"description"</span>,</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="stringliteral">"email"</span>,</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="stringliteral">"version"</span>,</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="stringliteral">"urls"</span>,</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="stringliteral">"languages"</span>,</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="stringliteral">"contact_account"</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  }};</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordflow">return</span> <a class="code" href="classMastodon_1_1Easy_1_1Entity.html#a9af50e48d1241e0c2f32b2032312cfef">Entity::check_valid</a>(attributes);</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> }</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< string > &attributes) const</div><div class="ttdoc">Checks if an Entity is valid. </div><div class="ttdef"><b>Definition:</b> entity.cpp:69</div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a0a0c2656943c60f490d18894e4806c7f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0a0c2656943c60f490d18894e4806c7f">◆ </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="l00088"></a><span class="lineno"> 88</span> {</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordflow">return</span> <a class="code" href="classMastodon_1_1Easy_1_1Entity.html#adb8d99a42bce94868a5bd68937cc1e93">get_string</a>(<span class="stringliteral">"version"</span>);</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> }</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 &key) const</div><div class="ttdoc">Returns the value of key as std::string. </div><div class="ttdef"><b>Definition:</b> entity.cpp:134</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  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.14
|
|
</small></address>
|
|
</body>
|
|
</html>
|