tastytea
/
mastodon-cpp
Archived
1
0
Fork 0
Code Issues 2 Pull Requests Releases 26 Wiki Activity
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/instance_8hpp_source.html

78 lines
20 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>mastodon-cpp: src/easy/entities/instance.hpp Source File</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="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_9d328871126a6a5820f3cd5c0c41741e.html">easy</a></li><li class="navelem"><a class="el" href="dir_e526f556af6ddef7955f0f6556f0f4d0.html">entities</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">instance.hpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/* This file is part of mastodon-cpp.</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Copyright © 2018, 2019 tastytea &lt;tastytea@tastytea.de&gt;</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * This program is free software: you can redistribute it and/or modify</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * it under the terms of the GNU Affero General Public License as published by</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * the Free Software Foundation, version 3.</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * This program is distributed in the hope that it will be useful,</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * GNU Affero General Public License for more details.</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * You should have received a copy of the GNU Affero General Public License</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * along with this program. If not, see &lt;http://www.gnu.org/licenses/&gt;.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#ifndef MASTODON_CPP_EASY_INSTANCE_HPP</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#define MASTODON_CPP_EASY_INSTANCE_HPP</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="keyword">using</span> std::uint64_t;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &quot;../../mastodon-cpp.hpp&quot;</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &quot;../entity.hpp&quot;</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#include &quot;account.hpp&quot;</span></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="keyword">using</span> std::string;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceMastodon.html">Mastodon</a></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;{</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="keyword">namespace </span>Easy</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;{</div><div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="classMastodon_1_1Easy_1_1Instance.html"> 40</a></span>&#160; <span class="keyword">class </span><a class="code" href="classMastodon_1_1Easy_1_1Instance.html">Instance</a> : <span class="keyword">public</span> <a class="code" href="classMastodon_1_1Easy_1_1Entity.html">Entity</a></div><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">public</span>:</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keyword">using</span> <a class="code" href="classMastodon_1_1Easy_1_1Entity.html#a83eb2be5a13eaaa22b2796f05817f7a9">Entity::Entity</a>;</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="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classMastodon_1_1Easy_1_1Instance.html#a22141e6d58a5dfdf15a36dfe5430cb0b">valid</a>() <span class="keyword">const override</span>;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keyword">const</span> <a class="code" href="classMastodon_1_1Easy_1_1Account.html">Account</a> <a class="code" href="classMastodon_1_1Easy_1_1Instance.html#ad64fce6e6d2f9bd163982427ef898292">contact_account</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keyword">const</span> <span class="keywordtype">string</span> <a class="code" href="classMastodon_1_1Easy_1_1Instance.html#a88c0adac4c861936a9eaa77514dfc663">description</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keyword">const</span> <span class="keywordtype">string</span> <a class="code" href="classMastodon_1_1Easy_1_1Instance.html#a9ae503d864ac04669520d1be8da3aeb4">email</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="keyword">const</span> vector&lt;string&gt; <a class="code" href="classMastodon_1_1Easy_1_1Instance.html#aebfa2f19d09cbc83aec06f414bc3bcbb">languages</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <span class="keyword">const</span> <span class="keywordtype">string</span> <a class="code" href="classMastodon_1_1Easy_1_1Instance.html#a8df717fc6dfa55f47f02c42800d9e6e6">thumbnail</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <span class="keyword">const</span> <span class="keywordtype">string</span> <a class="code" href="classMastodon_1_1Easy_1_1Instance.html#acb7508b6348d12d1187b70d19643b15a">title</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="keyword">const</span> <span class="keywordtype">string</span> <a class="code" href="classMastodon_1_1Easy_1_1Instance.html#af967f5933e097c6a449d291ac16043c1">uri</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <span class="keyword">const</span> <a class="code" href="structMastodon_1_1Easy_1_1urls__type.html">Easy::urls_type</a> <a class="code" href="classMastodon_1_1Easy_1_1Instance.html#a4a43fc90dc117f65ea640e1d4df36460">urls</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; <span class="keyword">const</span> <a class="code" href="structMastodon_1_1Easy_1_1stats__type.html">Easy::stats_type</a> <a class="code" href="classMastodon_1_1Easy_1_1Instance.html#ab482669c1643bc362fe14ed1deb91c8c">stats</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; <span class="keyword">const</span> <span class="keywordtype">string</span> <a class="code" href="classMastodon_1_1Easy_1_1Instance.html#a0a0c2656943c60f490d18894e4806c7f">version</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160;</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; uint64_t <a class="code" href="classMastodon_1_1Easy_1_1Instance.html#aab07d99500d330c0a28b3778f254febe">max_toot_chars</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; };</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160;}</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160;}</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160;</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160;<span class="preprocessor">#endif // MASTODON_CPP_EASY_INSTANCE_HPP</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:43</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Instance_html_a4a43fc90dc117f65ea640e1d4df36460"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Instance.html#a4a43fc90dc117f65ea640e1d4df36460">Mastodon::Easy::Instance::urls</a></div><div class="ttdeci">const Easy::urls_type urls() const</div><div class="ttdoc">Returns the URL for the streaming API and possibly others.</div><div class="ttdef"><b>Definition:</b> instance.cpp:85</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Instance_html"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Instance.html">Mastodon::Easy::Instance</a></div><div class="ttdoc">Class to hold instances.</div><div class="ttdef"><b>Definition:</b> instance.hpp:40</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Instance_html_aebfa2f19d09cbc83aec06f414bc3bcbb"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Instance.html#aebfa2f19d09cbc83aec06f414bc3bcbb">Mastodon::Easy::Instance::languages</a></div><div class="ttdeci">const vector&lt; string &gt; languages() const</div><div class="ttdoc">Returns a vector of ISO 6391 language codes the instance has chosen to advertise.</div><div class="ttdef"><b>Definition:</b> instance.cpp:61</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Instance_html_af967f5933e097c6a449d291ac16043c1"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Instance.html#af967f5933e097c6a449d291ac16043c1">Mastodon::Easy::Instance::uri</a></div><div class="ttdeci">const string uri() const</div><div class="ttdoc">Returns the URI of the instance.</div><div class="ttdef"><b>Definition:</b> instance.cpp:80</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 class="ttc" id="classMastodon_1_1Easy_1_1Instance_html_a9ae503d864ac04669520d1be8da3aeb4"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Instance.html#a9ae503d864ac04669520d1be8da3aeb4">Mastodon::Easy::Instance::email</a></div><div class="ttdeci">const string email() const</div><div class="ttdoc">Returns the email address which can be used to contact the instance administrator.</div><div class="ttdef"><b>Definition:</b> instance.cpp:56</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Instance_html_ab482669c1643bc362fe14ed1deb91c8c"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Instance.html#ab482669c1643bc362fe14ed1deb91c8c">Mastodon::Easy::Instance::stats</a></div><div class="ttdeci">const Easy::stats_type stats() const</div><div class="ttdoc">Returns statistics about the instance.</div><div class="ttdef"><b>Definition:</b> instance.cpp:66</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Instance_html_acb7508b6348d12d1187b70d19643b15a"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Instance.html#acb7508b6348d12d1187b70d19643b15a">Mastodon::Easy::Instance::title</a></div><div class="ttdeci">const string title() const</div><div class="ttdoc">Returns the title of the instance.</div><div class="ttdef"><b>Definition:</b> instance.cpp:75</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Instance_html_ad64fce6e6d2f9bd163982427ef898292"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Instance.html#ad64fce6e6d2f9bd163982427ef898292">Mastodon::Easy::Instance::contact_account</a></div><div class="ttdeci">const Account contact_account() const</div><div class="ttdoc">Returns the Account of the admin or another contact person.</div><div class="ttdef"><b>Definition:</b> instance.cpp:40</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Instance_html_a8df717fc6dfa55f47f02c42800d9e6e6"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Instance.html#a8df717fc6dfa55f47f02c42800d9e6e6">Mastodon::Easy::Instance::thumbnail</a></div><div class="ttdeci">const string thumbnail() const</div><div class="ttdoc">Returns the thumbnail of the instance.</div><div class="ttdef"><b>Definition:</b> instance.cpp:95</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 class="ttc" id="classMastodon_1_1Easy_1_1Instance_html_aab07d99500d330c0a28b3778f254febe"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Instance.html#aab07d99500d330c0a28b3778f254febe">Mastodon::Easy::Instance::max_toot_chars</a></div><div class="ttdeci">uint64_t max_toot_chars() const</div><div class="ttdoc">Returns the maximum chars a post can have.</div><div class="ttdef"><b>Definition:</b> instance.cpp:100</div></div>
<div class="ttc" id="namespaceMastodon_html"><div class="ttname"><a href="namespaceMastodon.html">Mastodon</a></div><div class="ttdoc">Collection of things to interface with server software that implements the Mastodon API.</div><div class="ttdef"><b>Definition:</b> mastodon-cpp.hpp:47</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Entity_html"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Entity.html">Mastodon::Easy::Entity</a></div><div class="ttdoc">Base class for all entities.</div><div class="ttdef"><b>Definition:</b> entity.hpp:36</div></div>
<div class="ttc" id="structMastodon_1_1Easy_1_1urls__type_html"><div class="ttname"><a href="structMastodon_1_1Easy_1_1urls__type.html">Mastodon::Easy::urls_type</a></div><div class="ttdoc">URLs returned by Instance::urls().</div><div class="ttdef"><b>Definition:</b> types_easy.hpp:214</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Instance_html_a22141e6d58a5dfdf15a36dfe5430cb0b"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Instance.html#a22141e6d58a5dfdf15a36dfe5430cb0b">Mastodon::Easy::Instance::valid</a></div><div class="ttdeci">virtual bool valid() const override</div><div class="ttdoc">Returns true if the Entity holds valid data.</div><div class="ttdef"><b>Definition:</b> instance.cpp:25</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Instance_html_a88c0adac4c861936a9eaa77514dfc663"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Instance.html#a88c0adac4c861936a9eaa77514dfc663">Mastodon::Easy::Instance::description</a></div><div class="ttdeci">const string description() const</div><div class="ttdoc">Returns the description of the instance.</div><div class="ttdef"><b>Definition:</b> instance.cpp:51</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Instance_html_a0a0c2656943c60f490d18894e4806c7f"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Instance.html#a0a0c2656943c60f490d18894e4806c7f">Mastodon::Easy::Instance::version</a></div><div class="ttdeci">const string version() const</div><div class="ttdoc">Returns the version used by the instance.</div><div class="ttdef"><b>Definition:</b> instance.cpp:90</div></div>
</div><!-- fragment --></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>
Reference in New Issue View Git Blame Copy Permalink