248 lines
36 KiB
HTML
248 lines
36 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.9.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>mastodonpp: include/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="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.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">mastodonpp
|
|
 <span id="projectnumber">0.5.7</span>
|
|
</div>
|
|
<div id="projectbrief">C++ wrapper for the Mastodon and Pleroma APIs.</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.1 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
|
|
/* @license-end */
|
|
</script>
|
|
<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('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</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> <span class="comment">/* This file is part of mastodonpp.</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright © 2020 tastytea <tastytea@tastytea.de></span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <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> <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> <span class="comment"> * the Free Software Foundation, version 3.</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <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> <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> <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> <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> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <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> <span class="comment"> * along with this program. If not, see <http://www.gnu.org/licenses/>.</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  </div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#ifndef MASTODONPP_INSTANCE_HPP</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#define MASTODONPP_INSTANCE_HPP</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include "curl_wrapper.hpp"</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include "types.hpp"</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <cstdint></span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <string></span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <string_view></span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <utility></span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <vector></span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">namespace </span><a class="code" href="namespacemastodonpp.html">mastodonpp</a></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> {</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  </div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">using</span> std::string;</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">using</span> std::string_view;</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">using</span> std::uint64_t;</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">using</span> std::vector;</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  </div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="classmastodonpp_1_1Instance.html"> 48</a></span> <span class="keyword">class </span><a class="code" href="classmastodonpp_1_1Instance.html">Instance</a> : <span class="keyword">public</span> <a class="code" href="classmastodonpp_1_1CURLWrapper.html">CURLWrapper</a></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> {</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="classmastodonpp_1_1Instance.html#a21b859e2b9b5c6f48e8d0a194a659888"> 59</a></span>  <span class="keyword">explicit</span> <a class="code" href="classmastodonpp_1_1Instance.html#a21b859e2b9b5c6f48e8d0a194a659888">Instance</a>(string_view hostname, string_view access_token);</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  </div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="classmastodonpp_1_1Instance.html#a14551e7c53caeaa32b6817ccafc6af0e"> 66</a></span>  <a class="code" href="classmastodonpp_1_1Instance.html#a14551e7c53caeaa32b6817ccafc6af0e">Instance</a>(<span class="keyword">const</span> <a class="code" href="classmastodonpp_1_1Instance.html">Instance</a> &other);</div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  </div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="classmastodonpp_1_1Instance.html#a827ebc5b43e1cba9b5b7eb4d5ebcd4bd"> 69</a></span>  <a class="code" href="classmastodonpp_1_1Instance.html#a827ebc5b43e1cba9b5b7eb4d5ebcd4bd">Instance</a>(<a class="code" href="classmastodonpp_1_1Instance.html">Instance</a> &&other) noexcept = <span class="keyword">delete</span>;</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  </div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="classmastodonpp_1_1Instance.html#adec12eb92831f3530f55c507a33446be"> 72</a></span>  <a class="code" href="classmastodonpp_1_1Instance.html#adec12eb92831f3530f55c507a33446be">~Instance</a>() noexcept override = default;</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  </div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"><a class="line" href="classmastodonpp_1_1Instance.html#a87f44b0dd1fb1b2daebde560847e9da7"> 75</a></span>  <a class="code" href="classmastodonpp_1_1Instance.html">Instance</a> &operator=(const <a class="code" href="classmastodonpp_1_1Instance.html">Instance</a> &other) = delete;</div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  </div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="classmastodonpp_1_1Instance.html#af7202e8b775dee75acbccb4cc569a14e"> 78</a></span>  <a class="code" href="classmastodonpp_1_1Instance.html">Instance</a> &operator=(<a class="code" href="classmastodonpp_1_1Instance.html">Instance</a> &&other) noexcept = delete;</div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  </div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"><a class="line" href="classmastodonpp_1_1Instance.html#a921c4b83815c0d98dea983a9409c00ac"> 90</a></span>  inline <span class="keywordtype">void</span> <a class="code" href="classmastodonpp_1_1Instance.html#a921c4b83815c0d98dea983a9409c00ac">copy_connection_properties</a>(<a class="code" href="classmastodonpp_1_1CURLWrapper.html">CURLWrapper</a> &curlwrapper)<span class="keyword"> const</span></div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="keyword"> </span>{</div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  curlwrapper.setup_connection_properties(_proxy, _access_token, _cainfo,</div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  _useragent);</div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  }</div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  </div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"><a class="line" href="classmastodonpp_1_1Instance.html#a868aae1fae3ad4060759c1325acb3b62"> 101</a></span>  [[nodiscard]] <span class="keyword">inline</span> string_view <a class="code" href="classmastodonpp_1_1Instance.html#a868aae1fae3ad4060759c1325acb3b62">get_hostname</a>() const noexcept</div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  {</div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keywordflow">return</span> _hostname;</div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  }</div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  </div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"><a class="line" href="classmastodonpp_1_1Instance.html#a859540ec79ea97c0f76185d9036127bb"> 113</a></span>  [[nodiscard]] <span class="keyword">inline</span> string_view <a class="code" href="classmastodonpp_1_1Instance.html#a859540ec79ea97c0f76185d9036127bb">get_baseuri</a>() const noexcept</div>
|
|
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  {</div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keywordflow">return</span> _baseuri;</div>
|
|
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  }</div>
|
|
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  </div>
|
|
<div class="line"><a name="l00123"></a><span class="lineno"><a class="line" href="classmastodonpp_1_1Instance.html#a3fcd68515b1d07a4003bc09180fff904"> 123</a></span>  [[nodiscard]] <span class="keyword">inline</span> string_view <a class="code" href="classmastodonpp_1_1Instance.html#a3fcd68515b1d07a4003bc09180fff904">get_access_token</a>() const noexcept</div>
|
|
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  {</div>
|
|
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="keywordflow">return</span> _access_token;</div>
|
|
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  }</div>
|
|
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  </div>
|
|
<div class="line"><a name="l00136"></a><span class="lineno"><a class="line" href="classmastodonpp_1_1Instance.html#a3627363d1891a4cfd27f3a27437f4f2e"> 136</a></span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classmastodonpp_1_1Instance.html#a3627363d1891a4cfd27f3a27437f4f2e">set_access_token</a>(<span class="keyword">const</span> string_view access_token)</div>
|
|
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  {</div>
|
|
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  _access_token = access_token;</div>
|
|
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <a class="code" href="classmastodonpp_1_1CURLWrapper.html#a94aba6daedea376ccc20e5c983bd3358">CURLWrapper::set_access_token</a>(access_token);</div>
|
|
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  }</div>
|
|
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  </div>
|
|
<div class="line"><a name="l00153"></a><span class="lineno"><a class="line" href="classmastodonpp_1_1Instance.html#a3d9f535570e6083b7f37b3c5e42c08dd"> 153</a></span>  [[nodiscard]] uint64_t <a class="code" href="classmastodonpp_1_1Instance.html#a3d9f535570e6083b7f37b3c5e42c08dd">get_max_chars</a>() noexcept;</div>
|
|
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  </div>
|
|
<div class="line"><a name="l00160"></a><span class="lineno"><a class="line" href="classmastodonpp_1_1Instance.html#ab329a0780a1f0581d4771cac4e958157"> 160</a></span>  <span class="keywordtype">void</span> <a class="code" href="classmastodonpp_1_1Instance.html#ab329a0780a1f0581d4771cac4e958157">set_proxy</a>(const string_view proxy)<span class="keyword"> override</span></div>
|
|
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="keyword"> </span>{</div>
|
|
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  _proxy = proxy;</div>
|
|
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  <a class="code" href="classmastodonpp_1_1CURLWrapper.html#a1564a42794ef7a9d170b725063ef504d">CURLWrapper::set_proxy</a>(proxy);</div>
|
|
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  }</div>
|
|
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  </div>
|
|
<div class="line"><a name="l00175"></a><span class="lineno"><a class="line" href="classmastodonpp_1_1Instance.html#a4d594e1365584a05e5a16fc8aea76e9d"> 175</a></span>  [[nodiscard]] <a class="code" href="structmastodonpp_1_1answer__type.html">answer_type</a> <a class="code" href="classmastodonpp_1_1Instance.html#a4d594e1365584a05e5a16fc8aea76e9d">get_nodeinfo</a>();</div>
|
|
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  </div>
|
|
<div class="line"><a name="l00188"></a><span class="lineno"><a class="line" href="classmastodonpp_1_1Instance.html#a84b7e4ef6e05f7f7208b557c38b5ad1e"> 188</a></span>  vector<string> <a class="code" href="classmastodonpp_1_1Instance.html#a84b7e4ef6e05f7f7208b557c38b5ad1e">get_post_formats</a>() noexcept;</div>
|
|
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  </div>
|
|
<div class="line"><a name="l00198"></a><span class="lineno"><a class="line" href="classmastodonpp_1_1Instance.html#a0601321fe7a8b22a42cf6e7d2d817b72"> 198</a></span>  <span class="keywordtype">void</span> <a class="code" href="classmastodonpp_1_1Instance.html#a0601321fe7a8b22a42cf6e7d2d817b72">set_cainfo</a>(string_view path)<span class="keyword"> override</span></div>
|
|
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="keyword"> </span>{</div>
|
|
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  _cainfo = path;</div>
|
|
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span>  <a class="code" href="classmastodonpp_1_1CURLWrapper.html#af3f2bd4dea7c289d590fe19889360444">CURLWrapper::set_cainfo</a>(path);</div>
|
|
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  }</div>
|
|
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span>  </div>
|
|
<div class="line"><a name="l00212"></a><span class="lineno"><a class="line" href="classmastodonpp_1_1Instance.html#a3eb6b1a045ad465ec4fd3ad9febc244b"> 212</a></span>  <span class="keywordtype">void</span> <a class="code" href="classmastodonpp_1_1Instance.html#a3eb6b1a045ad465ec4fd3ad9febc244b">set_useragent</a>(<span class="keyword">const</span> string_view useragent)<span class="keyword"> override</span></div>
|
|
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="keyword"> </span>{</div>
|
|
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span>  _useragent = useragent;</div>
|
|
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  <a class="code" href="classmastodonpp_1_1CURLWrapper.html#ae3b1445f9b94b1f7677d3cac6d538612">CURLWrapper::set_useragent</a>(useragent);</div>
|
|
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span>  }</div>
|
|
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span>  </div>
|
|
<div class="line"><a name="l00248"></a><span class="lineno"><a class="line" href="classmastodonpp_1_1Instance_1_1ObtainToken.html"> 248</a></span>  <span class="keyword">class </span><a class="code" href="classmastodonpp_1_1Instance_1_1ObtainToken.html">ObtainToken</a> : <span class="keyword">public</span> <a class="code" href="classmastodonpp_1_1CURLWrapper.html">CURLWrapper</a></div>
|
|
<div class="line"><a name="l00249"></a><span class="lineno"> 249</span>  {</div>
|
|
<div class="line"><a name="l00250"></a><span class="lineno"> 250</span>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00256"></a><span class="lineno"><a class="line" href="classmastodonpp_1_1Instance_1_1ObtainToken.html#aa834d9be223856e5711b0e14d9b92eed"> 256</a></span>  <span class="keyword">explicit</span> <a class="code" href="classmastodonpp_1_1Instance_1_1ObtainToken.html#aa834d9be223856e5711b0e14d9b92eed">ObtainToken</a>(<a class="code" href="classmastodonpp_1_1Instance.html">Instance</a> &instance)</div>
|
|
<div class="line"><a name="l00257"></a><span class="lineno"> 257</span>  : _instance{instance}</div>
|
|
<div class="line"><a name="l00258"></a><span class="lineno"> 258</span>  , _baseuri{instance.<a class="code" href="classmastodonpp_1_1Instance.html#a859540ec79ea97c0f76185d9036127bb">get_baseuri</a>()}</div>
|
|
<div class="line"><a name="l00259"></a><span class="lineno"> 259</span>  {</div>
|
|
<div class="line"><a name="l00260"></a><span class="lineno"> 260</span>  _instance.<a class="code" href="classmastodonpp_1_1Instance.html#a921c4b83815c0d98dea983a9409c00ac">copy_connection_properties</a>(*<span class="keyword">this</span>);</div>
|
|
<div class="line"><a name="l00261"></a><span class="lineno"> 261</span>  }</div>
|
|
<div class="line"><a name="l00262"></a><span class="lineno"> 262</span>  </div>
|
|
<div class="line"><a name="l00282"></a><span class="lineno"><a class="line" href="classmastodonpp_1_1Instance_1_1ObtainToken.html#a5bd5d631e2fbb186a9df66d2ac3f5402"> 282</a></span>  [[nodiscard]] <a class="code" href="structmastodonpp_1_1answer__type.html">answer_type</a> <a class="code" href="classmastodonpp_1_1Instance_1_1ObtainToken.html#a5bd5d631e2fbb186a9df66d2ac3f5402">step_1</a>(string_view client_name,</div>
|
|
<div class="line"><a name="l00283"></a><span class="lineno"> 283</span>  string_view scopes,</div>
|
|
<div class="line"><a name="l00284"></a><span class="lineno"> 284</span>  string_view website);</div>
|
|
<div class="line"><a name="l00285"></a><span class="lineno"> 285</span>  </div>
|
|
<div class="line"><a name="l00301"></a><span class="lineno"><a class="line" href="classmastodonpp_1_1Instance_1_1ObtainToken.html#addda7f4e1ca4200235764707478f6d51"> 301</a></span>  [[nodiscard]] <a class="code" href="structmastodonpp_1_1answer__type.html">answer_type</a> <a class="code" href="classmastodonpp_1_1Instance_1_1ObtainToken.html#addda7f4e1ca4200235764707478f6d51">step_2</a>(string_view code);</div>
|
|
<div class="line"><a name="l00302"></a><span class="lineno"> 302</span>  </div>
|
|
<div class="line"><a name="l00303"></a><span class="lineno"> 303</span>  <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00304"></a><span class="lineno"> 304</span>  <a class="code" href="classmastodonpp_1_1Instance.html">Instance</a> &_instance;</div>
|
|
<div class="line"><a name="l00305"></a><span class="lineno"> 305</span>  <span class="keyword">const</span> <span class="keywordtype">string</span> _baseuri;</div>
|
|
<div class="line"><a name="l00306"></a><span class="lineno"> 306</span>  <span class="keywordtype">string</span> _scopes;</div>
|
|
<div class="line"><a name="l00307"></a><span class="lineno"> 307</span>  <span class="keywordtype">string</span> _client_id;</div>
|
|
<div class="line"><a name="l00308"></a><span class="lineno"> 308</span>  <span class="keywordtype">string</span> _client_secret;</div>
|
|
<div class="line"><a name="l00309"></a><span class="lineno"> 309</span>  };</div>
|
|
<div class="line"><a name="l00310"></a><span class="lineno"> 310</span>  </div>
|
|
<div class="line"><a name="l00311"></a><span class="lineno"> 311</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00312"></a><span class="lineno"> 312</span>  <span class="keyword">const</span> <span class="keywordtype">string</span> _hostname;</div>
|
|
<div class="line"><a name="l00313"></a><span class="lineno"> 313</span>  <span class="keyword">const</span> <span class="keywordtype">string</span> _baseuri;</div>
|
|
<div class="line"><a name="l00314"></a><span class="lineno"> 314</span>  <span class="keywordtype">string</span> _access_token;</div>
|
|
<div class="line"><a name="l00315"></a><span class="lineno"> 315</span>  uint64_t _max_chars;</div>
|
|
<div class="line"><a name="l00316"></a><span class="lineno"> 316</span>  <span class="keywordtype">string</span> _proxy;</div>
|
|
<div class="line"><a name="l00317"></a><span class="lineno"> 317</span>  vector<string> _post_formats;</div>
|
|
<div class="line"><a name="l00318"></a><span class="lineno"> 318</span>  <span class="keywordtype">string</span> _cainfo;</div>
|
|
<div class="line"><a name="l00319"></a><span class="lineno"> 319</span>  <span class="keywordtype">string</span> _useragent;</div>
|
|
<div class="line"><a name="l00320"></a><span class="lineno"> 320</span> };</div>
|
|
<div class="line"><a name="l00321"></a><span class="lineno"> 321</span>  </div>
|
|
<div class="line"><a name="l00322"></a><span class="lineno"> 322</span> } <span class="comment">// namespace mastodonpp</span></div>
|
|
<div class="line"><a name="l00323"></a><span class="lineno"> 323</span>  </div>
|
|
<div class="line"><a name="l00324"></a><span class="lineno"> 324</span> <span class="preprocessor">#endif </span><span class="comment">// MASTODONPP_INSTANCE_HPP</span></div>
|
|
<div class="ttc" id="aclassmastodonpp_1_1CURLWrapper_html"><div class="ttname"><a href="classmastodonpp_1_1CURLWrapper.html">mastodonpp::CURLWrapper</a></div><div class="ttdoc">Handles the details of network connections.</div><div class="ttdef"><b>Definition:</b> curl_wrapper.hpp:58</div></div>
|
|
<div class="ttc" id="aclassmastodonpp_1_1CURLWrapper_html_a1564a42794ef7a9d170b725063ef504d"><div class="ttname"><a href="classmastodonpp_1_1CURLWrapper.html#a1564a42794ef7a9d170b725063ef504d">mastodonpp::CURLWrapper::set_proxy</a></div><div class="ttdeci">virtual void set_proxy(string_view proxy)</div><div class="ttdoc">Set the proxy to use.</div><div class="ttdef"><b>Definition:</b> curl_wrapper.cpp:229</div></div>
|
|
<div class="ttc" id="aclassmastodonpp_1_1CURLWrapper_html_a94aba6daedea376ccc20e5c983bd3358"><div class="ttname"><a href="classmastodonpp_1_1CURLWrapper.html#a94aba6daedea376ccc20e5c983bd3358">mastodonpp::CURLWrapper::set_access_token</a></div><div class="ttdeci">void set_access_token(string_view access_token)</div><div class="ttdoc">Set OAuth 2.0 Bearer Access Token.</div><div class="ttdef"><b>Definition:</b> curl_wrapper.cpp:240</div></div>
|
|
<div class="ttc" id="aclassmastodonpp_1_1CURLWrapper_html_ae3b1445f9b94b1f7677d3cac6d538612"><div class="ttname"><a href="classmastodonpp_1_1CURLWrapper.html#ae3b1445f9b94b1f7677d3cac6d538612">mastodonpp::CURLWrapper::set_useragent</a></div><div class="ttdeci">virtual void set_useragent(string_view useragent)</div><div class="ttdoc">Sets the User-Agent.</div><div class="ttdef"><b>Definition:</b> curl_wrapper.cpp:276</div></div>
|
|
<div class="ttc" id="aclassmastodonpp_1_1CURLWrapper_html_af3f2bd4dea7c289d590fe19889360444"><div class="ttname"><a href="classmastodonpp_1_1CURLWrapper.html#af3f2bd4dea7c289d590fe19889360444">mastodonpp::CURLWrapper::set_cainfo</a></div><div class="ttdeci">virtual void set_cainfo(string_view path)</div><div class="ttdoc">Set path to Certificate Authority (CA) bundle.</div><div class="ttdef"><b>Definition:</b> curl_wrapper.cpp:266</div></div>
|
|
<div class="ttc" id="aclassmastodonpp_1_1Instance_1_1ObtainToken_html"><div class="ttname"><a href="classmastodonpp_1_1Instance_1_1ObtainToken.html">mastodonpp::Instance::ObtainToken</a></div><div class="ttdoc">Simplifies obtaining an OAuth 2.0 Bearer Access Token.</div><div class="ttdef"><b>Definition:</b> instance.hpp:249</div></div>
|
|
<div class="ttc" id="aclassmastodonpp_1_1Instance_1_1ObtainToken_html_a5bd5d631e2fbb186a9df66d2ac3f5402"><div class="ttname"><a href="classmastodonpp_1_1Instance_1_1ObtainToken.html#a5bd5d631e2fbb186a9df66d2ac3f5402">mastodonpp::Instance::ObtainToken::step_1</a></div><div class="ttdeci">answer_type step_1(string_view client_name, string_view scopes, string_view website)</div><div class="ttdoc">Creates an application via /api/v1/apps.</div></div>
|
|
<div class="ttc" id="aclassmastodonpp_1_1Instance_1_1ObtainToken_html_aa834d9be223856e5711b0e14d9b92eed"><div class="ttname"><a href="classmastodonpp_1_1Instance_1_1ObtainToken.html#aa834d9be223856e5711b0e14d9b92eed">mastodonpp::Instance::ObtainToken::ObtainToken</a></div><div class="ttdeci">ObtainToken(Instance &instance)</div><div class="ttdoc">Constructor.</div><div class="ttdef"><b>Definition:</b> instance.hpp:256</div></div>
|
|
<div class="ttc" id="aclassmastodonpp_1_1Instance_1_1ObtainToken_html_addda7f4e1ca4200235764707478f6d51"><div class="ttname"><a href="classmastodonpp_1_1Instance_1_1ObtainToken.html#addda7f4e1ca4200235764707478f6d51">mastodonpp::Instance::ObtainToken::step_2</a></div><div class="ttdeci">answer_type step_2(string_view code)</div><div class="ttdoc">Creates a token via /oauth/token.</div></div>
|
|
<div class="ttc" id="aclassmastodonpp_1_1Instance_html"><div class="ttname"><a href="classmastodonpp_1_1Instance.html">mastodonpp::Instance</a></div><div class="ttdoc">Holds the access data of an instance.</div><div class="ttdef"><b>Definition:</b> instance.hpp:49</div></div>
|
|
<div class="ttc" id="aclassmastodonpp_1_1Instance_html_a0601321fe7a8b22a42cf6e7d2d817b72"><div class="ttname"><a href="classmastodonpp_1_1Instance.html#a0601321fe7a8b22a42cf6e7d2d817b72">mastodonpp::Instance::set_cainfo</a></div><div class="ttdeci">void set_cainfo(string_view path) override</div><div class="ttdoc">Set path to Certificate Authority (CA) bundle.</div><div class="ttdef"><b>Definition:</b> instance.hpp:198</div></div>
|
|
<div class="ttc" id="aclassmastodonpp_1_1Instance_html_a14551e7c53caeaa32b6817ccafc6af0e"><div class="ttname"><a href="classmastodonpp_1_1Instance.html#a14551e7c53caeaa32b6817ccafc6af0e">mastodonpp::Instance::Instance</a></div><div class="ttdeci">Instance(const Instance &other)</div><div class="ttdoc">Copy constructor. A new CURLWrapper is constructed.</div></div>
|
|
<div class="ttc" id="aclassmastodonpp_1_1Instance_html_a21b859e2b9b5c6f48e8d0a194a659888"><div class="ttname"><a href="classmastodonpp_1_1Instance.html#a21b859e2b9b5c6f48e8d0a194a659888">mastodonpp::Instance::Instance</a></div><div class="ttdeci">Instance(string_view hostname, string_view access_token)</div><div class="ttdoc">Construct a new Instance object.</div></div>
|
|
<div class="ttc" id="aclassmastodonpp_1_1Instance_html_a3627363d1891a4cfd27f3a27437f4f2e"><div class="ttname"><a href="classmastodonpp_1_1Instance.html#a3627363d1891a4cfd27f3a27437f4f2e">mastodonpp::Instance::set_access_token</a></div><div class="ttdeci">void set_access_token(const string_view access_token)</div><div class="ttdoc">Set OAuth 2.0 Bearer Access Token.</div><div class="ttdef"><b>Definition:</b> instance.hpp:136</div></div>
|
|
<div class="ttc" id="aclassmastodonpp_1_1Instance_html_a3d9f535570e6083b7f37b3c5e42c08dd"><div class="ttname"><a href="classmastodonpp_1_1Instance.html#a3d9f535570e6083b7f37b3c5e42c08dd">mastodonpp::Instance::get_max_chars</a></div><div class="ttdeci">uint64_t get_max_chars() noexcept</div><div class="ttdoc">Returns the maximum number of characters per post.</div></div>
|
|
<div class="ttc" id="aclassmastodonpp_1_1Instance_html_a3eb6b1a045ad465ec4fd3ad9febc244b"><div class="ttname"><a href="classmastodonpp_1_1Instance.html#a3eb6b1a045ad465ec4fd3ad9febc244b">mastodonpp::Instance::set_useragent</a></div><div class="ttdeci">void set_useragent(const string_view useragent) override</div><div class="ttdoc">Sets the User-Agent.</div><div class="ttdef"><b>Definition:</b> instance.hpp:212</div></div>
|
|
<div class="ttc" id="aclassmastodonpp_1_1Instance_html_a3fcd68515b1d07a4003bc09180fff904"><div class="ttname"><a href="classmastodonpp_1_1Instance.html#a3fcd68515b1d07a4003bc09180fff904">mastodonpp::Instance::get_access_token</a></div><div class="ttdeci">string_view get_access_token() const noexcept</div><div class="ttdoc">Returns the access token.</div><div class="ttdef"><b>Definition:</b> instance.hpp:123</div></div>
|
|
<div class="ttc" id="aclassmastodonpp_1_1Instance_html_a4d594e1365584a05e5a16fc8aea76e9d"><div class="ttname"><a href="classmastodonpp_1_1Instance.html#a4d594e1365584a05e5a16fc8aea76e9d">mastodonpp::Instance::get_nodeinfo</a></div><div class="ttdeci">answer_type get_nodeinfo()</div><div class="ttdoc">Returns the NodeInfo of the instance.</div></div>
|
|
<div class="ttc" id="aclassmastodonpp_1_1Instance_html_a827ebc5b43e1cba9b5b7eb4d5ebcd4bd"><div class="ttname"><a href="classmastodonpp_1_1Instance.html#a827ebc5b43e1cba9b5b7eb4d5ebcd4bd">mastodonpp::Instance::Instance</a></div><div class="ttdeci">Instance(Instance &&other) noexcept=delete</div><div class="ttdoc">Move constructor.</div></div>
|
|
<div class="ttc" id="aclassmastodonpp_1_1Instance_html_a84b7e4ef6e05f7f7208b557c38b5ad1e"><div class="ttname"><a href="classmastodonpp_1_1Instance.html#a84b7e4ef6e05f7f7208b557c38b5ad1e">mastodonpp::Instance::get_post_formats</a></div><div class="ttdeci">vector< string > get_post_formats() noexcept</div><div class="ttdoc">Returns the allowed mime types for statuses.</div></div>
|
|
<div class="ttc" id="aclassmastodonpp_1_1Instance_html_a859540ec79ea97c0f76185d9036127bb"><div class="ttname"><a href="classmastodonpp_1_1Instance.html#a859540ec79ea97c0f76185d9036127bb">mastodonpp::Instance::get_baseuri</a></div><div class="ttdeci">string_view get_baseuri() const noexcept</div><div class="ttdoc">Returns the base URI.</div><div class="ttdef"><b>Definition:</b> instance.hpp:113</div></div>
|
|
<div class="ttc" id="aclassmastodonpp_1_1Instance_html_a868aae1fae3ad4060759c1325acb3b62"><div class="ttname"><a href="classmastodonpp_1_1Instance.html#a868aae1fae3ad4060759c1325acb3b62">mastodonpp::Instance::get_hostname</a></div><div class="ttdeci">string_view get_hostname() const noexcept</div><div class="ttdoc">Returns the hostname.</div><div class="ttdef"><b>Definition:</b> instance.hpp:101</div></div>
|
|
<div class="ttc" id="aclassmastodonpp_1_1Instance_html_a921c4b83815c0d98dea983a9409c00ac"><div class="ttname"><a href="classmastodonpp_1_1Instance.html#a921c4b83815c0d98dea983a9409c00ac">mastodonpp::Instance::copy_connection_properties</a></div><div class="ttdeci">void copy_connection_properties(CURLWrapper &curlwrapper) const</div><div class="ttdoc">Set the properties of the connection of the calling class up.</div><div class="ttdef"><b>Definition:</b> instance.hpp:90</div></div>
|
|
<div class="ttc" id="aclassmastodonpp_1_1Instance_html_ab329a0780a1f0581d4771cac4e958157"><div class="ttname"><a href="classmastodonpp_1_1Instance.html#ab329a0780a1f0581d4771cac4e958157">mastodonpp::Instance::set_proxy</a></div><div class="ttdeci">void set_proxy(const string_view proxy) override</div><div class="ttdoc">Set the proxy to use.</div><div class="ttdef"><b>Definition:</b> instance.hpp:160</div></div>
|
|
<div class="ttc" id="aclassmastodonpp_1_1Instance_html_adec12eb92831f3530f55c507a33446be"><div class="ttname"><a href="classmastodonpp_1_1Instance.html#adec12eb92831f3530f55c507a33446be">mastodonpp::Instance::~Instance</a></div><div class="ttdeci">~Instance() noexcept override=default</div><div class="ttdoc">Destructor.</div></div>
|
|
<div class="ttc" id="anamespacemastodonpp_html"><div class="ttname"><a href="namespacemastodonpp.html">mastodonpp</a></div><div class="ttdoc">C++ wrapper for the Mastodon API.</div><div class="ttdef"><b>Definition:</b> api.hpp:25</div></div>
|
|
<div class="ttc" id="astructmastodonpp_1_1answer__type_html"><div class="ttname"><a href="structmastodonpp_1_1answer__type.html">mastodonpp::answer_type</a></div><div class="ttdoc">Return type for Requests.</div><div class="ttdef"><b>Definition:</b> types.hpp:80</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
|
|
</small></address>
|
|
</body>
|
|
</html>
|