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/relationship_8hpp_source.html

75 lines
19 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/relationship.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">relationship.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_RELATIONSHIP_HPP</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#define MASTODON_CPP_EASY_RELATIONSHIP_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;cstdint&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="preprocessor">#include &quot;../../mastodon-cpp.hpp&quot;</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &quot;../entity.hpp&quot;</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="keyword">using</span> std::string;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="keyword">using</span> std::uint64_t;</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">namespace </span><a class="code" href="namespaceMastodon.html">Mastodon</a></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>Easy</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;{</div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="classMastodon_1_1Easy_1_1Relationship.html"> 38</a></span>&#160; <span class="keyword">class </span><a class="code" href="classMastodon_1_1Easy_1_1Relationship.html">Relationship</a> : <span class="keyword">public</span> <a class="code" href="classMastodon_1_1Easy_1_1Entity.html">Entity</a></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</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="l00042"></a><span class="lineno"> 42</span>&#160;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classMastodon_1_1Easy_1_1Relationship.html#aca12192abfa476fc2dcf2bc1e4d80c11">valid</a>() <span class="keyword">const override</span>;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classMastodon_1_1Easy_1_1Relationship.html#acb6e9e2ba0dbaa02cbb6dd9abd3b7e2e">blocking</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classMastodon_1_1Easy_1_1Relationship.html#a1674aeecd39640c8649ac132d17be458">domain_blocking</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classMastodon_1_1Easy_1_1Relationship.html#afdf4f857f396ab254e38b0392ec1d368">endorsed</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classMastodon_1_1Easy_1_1Relationship.html#a8227f997f3fcdc466d02ada02c7f5db2">followed_by</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classMastodon_1_1Easy_1_1Relationship.html#a269736364ed42e3424204b31b9cd5ba2">following</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="keyword">const</span> <span class="keywordtype">string</span> <a class="code" href="classMastodon_1_1Easy_1_1Relationship.html#afc6987f74ebfd1c51a7a18a431713fd1">id</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classMastodon_1_1Easy_1_1Relationship.html#a683ecc9770ec59b063df4a1a02352b94">muting</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classMastodon_1_1Easy_1_1Relationship.html#a79a5feabf6e77f4aa7029337aae52e53">muting_notifications</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classMastodon_1_1Easy_1_1Relationship.html#aa87f574ad3842343d0936f4da8ea8740">requested</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160;</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classMastodon_1_1Easy_1_1Relationship.html#aea95214bc8831b34530952a665278e23">showing_notifications</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classMastodon_1_1Easy_1_1Relationship.html#a30dfd8840545803fbcbf3ced5eefbf00">showing_reblogs</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; };</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160;}</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160;}</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160;</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160;<span class="preprocessor">#endif // MASTODON_CPP_EASY_RELATIONSHIP_HPP</span></div><div class="ttc" id="classMastodon_1_1Easy_1_1Relationship_html_afc6987f74ebfd1c51a7a18a431713fd1"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Relationship.html#afc6987f74ebfd1c51a7a18a431713fd1">Mastodon::Easy::Relationship::id</a></div><div class="ttdeci">const string id() const</div><div class="ttdoc">Returns the target account ID.</div><div class="ttdef"><b>Definition:</b> relationship.cpp:64</div></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_1Relationship_html_aea95214bc8831b34530952a665278e23"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Relationship.html#aea95214bc8831b34530952a665278e23">Mastodon::Easy::Relationship::showing_notifications</a></div><div class="ttdeci">bool showing_notifications() const</div><div class="ttdoc">Returns true if the user is showing notifications.</div><div class="ttdef"><b>Definition:</b> relationship.cpp:84</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Relationship_html_acb6e9e2ba0dbaa02cbb6dd9abd3b7e2e"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Relationship.html#acb6e9e2ba0dbaa02cbb6dd9abd3b7e2e">Mastodon::Easy::Relationship::blocking</a></div><div class="ttdeci">bool blocking() const</div><div class="ttdoc">Returns true if the user is blocking the account.</div><div class="ttdef"><b>Definition:</b> relationship.cpp:39</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Relationship_html_a30dfd8840545803fbcbf3ced5eefbf00"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Relationship.html#a30dfd8840545803fbcbf3ced5eefbf00">Mastodon::Easy::Relationship::showing_reblogs</a></div><div class="ttdeci">bool showing_reblogs() const</div><div class="ttdoc">Returns true if the user is showing reblogs.</div><div class="ttdef"><b>Definition:</b> relationship.cpp:89</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Relationship_html_afdf4f857f396ab254e38b0392ec1d368"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Relationship.html#afdf4f857f396ab254e38b0392ec1d368">Mastodon::Easy::Relationship::endorsed</a></div><div class="ttdeci">bool endorsed() const</div><div class="ttdoc">Returns true if the account is endorsed by the user.</div><div class="ttdef"><b>Definition:</b> relationship.cpp:49</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Relationship_html_a8227f997f3fcdc466d02ada02c7f5db2"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Relationship.html#a8227f997f3fcdc466d02ada02c7f5db2">Mastodon::Easy::Relationship::followed_by</a></div><div class="ttdeci">bool followed_by() const</div><div class="ttdoc">Returns true if the user is being followed by the account.</div><div class="ttdef"><b>Definition:</b> relationship.cpp:54</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Relationship_html_a683ecc9770ec59b063df4a1a02352b94"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Relationship.html#a683ecc9770ec59b063df4a1a02352b94">Mastodon::Easy::Relationship::muting</a></div><div class="ttdeci">bool muting() const</div><div class="ttdoc">Returns true if the user is muting the account.</div><div class="ttdef"><b>Definition:</b> relationship.cpp:69</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Relationship_html_a79a5feabf6e77f4aa7029337aae52e53"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Relationship.html#a79a5feabf6e77f4aa7029337aae52e53">Mastodon::Easy::Relationship::muting_notifications</a></div><div class="ttdeci">bool muting_notifications() const</div><div class="ttdoc">Returns true if the user is also muting notifications.</div><div class="ttdef"><b>Definition:</b> relationship.cpp:74</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="classMastodon_1_1Easy_1_1Relationship_html_a1674aeecd39640c8649ac132d17be458"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Relationship.html#a1674aeecd39640c8649ac132d17be458">Mastodon::Easy::Relationship::domain_blocking</a></div><div class="ttdeci">bool domain_blocking() const</div><div class="ttdoc">Returns true if the user is blocking the account's domain.</div><div class="ttdef"><b>Definition:</b> relationship.cpp:44</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Relationship_html_a269736364ed42e3424204b31b9cd5ba2"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Relationship.html#a269736364ed42e3424204b31b9cd5ba2">Mastodon::Easy::Relationship::following</a></div><div class="ttdeci">bool following() const</div><div class="ttdoc">Returns true if the user is being following the account.</div><div class="ttdef"><b>Definition:</b> relationship.cpp:59</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Relationship_html"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Relationship.html">Mastodon::Easy::Relationship</a></div><div class="ttdoc">Class to hold relationships.</div><div class="ttdef"><b>Definition:</b> relationship.hpp:38</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Relationship_html_aca12192abfa476fc2dcf2bc1e4d80c11"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Relationship.html#aca12192abfa476fc2dcf2bc1e4d80c11">Mastodon::Easy::Relationship::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> relationship.cpp:22</div></div>
<div class="ttc" id="classMastodon_1_1Easy_1_1Relationship_html_aa87f574ad3842343d0936f4da8ea8740"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Relationship.html#aa87f574ad3842343d0936f4da8ea8740">Mastodon::Easy::Relationship::requested</a></div><div class="ttdeci">bool requested() const</div><div class="ttdoc">Returns true if the user has requested to follow the account.</div><div class="ttdef"><b>Definition:</b> relationship.cpp:79</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