776 lines
57 KiB
HTML
776 lines
57 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: mastodonpp::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="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="namespacemastodonpp.html">mastodonpp</a></li><li class="navelem"><a class="el" href="classmastodonpp_1_1Instance.html">Instance</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classmastodonpp_1_1Instance-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">mastodonpp::Instance Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Holds the access data of an instance.
|
|
<a href="classmastodonpp_1_1Instance.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="instance_8hpp_source.html">mastodonpp/instance.hpp</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for mastodonpp::Instance:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classmastodonpp_1_1Instance__inherit__graph.png" border="0" usemap="#amastodonpp_1_1Instance_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="amastodonpp_1_1Instance_inherit__map" id="amastodonpp_1_1Instance_inherit__map">
|
|
<area shape="rect" title="Holds the access data of an instance." alt="" coords="23,80,174,107"/>
|
|
<area shape="rect" href="classmastodonpp_1_1CURLWrapper.html" title="Handles the details of network connections." alt="" coords="5,5,192,32"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<div class="dynheader">
|
|
Collaboration diagram for mastodonpp::Instance:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classmastodonpp_1_1Instance__coll__graph.png" border="0" usemap="#amastodonpp_1_1Instance_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="amastodonpp_1_1Instance_coll__map" id="amastodonpp_1_1Instance_coll__map">
|
|
<area shape="rect" title="Holds the access data of an instance." alt="" coords="23,171,173,197"/>
|
|
<area shape="rect" href="classmastodonpp_1_1CURLWrapper.html" title="Handles the details of network connections." alt="" coords="5,95,191,121"/>
|
|
<area shape="rect" title=" " alt="" coords="56,5,140,32"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
|
Classes</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1Instance_1_1ObtainToken.html">ObtainToken</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Simplifies obtaining an OAuth 2.0 Bearer Access Token. <a href="classmastodonpp_1_1Instance_1_1ObtainToken.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><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:a21b859e2b9b5c6f48e8d0a194a659888"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1Instance.html#a21b859e2b9b5c6f48e8d0a194a659888">Instance</a> (string_view hostname, string_view access_token)</td></tr>
|
|
<tr class="memdesc:a21b859e2b9b5c6f48e8d0a194a659888"><td class="mdescLeft"> </td><td class="mdescRight">Construct a new <a class="el" href="classmastodonpp_1_1Instance.html" title="Holds the access data of an instance.">Instance</a> object. <a href="classmastodonpp_1_1Instance.html#a21b859e2b9b5c6f48e8d0a194a659888">More...</a><br /></td></tr>
|
|
<tr class="separator:a21b859e2b9b5c6f48e8d0a194a659888"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a14551e7c53caeaa32b6817ccafc6af0e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1Instance.html#a14551e7c53caeaa32b6817ccafc6af0e">Instance</a> (const <a class="el" href="classmastodonpp_1_1Instance.html">Instance</a> &other)</td></tr>
|
|
<tr class="memdesc:a14551e7c53caeaa32b6817ccafc6af0e"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. A new <a class="el" href="classmastodonpp_1_1CURLWrapper.html" title="Handles the details of network connections.">CURLWrapper</a> is constructed. <a href="classmastodonpp_1_1Instance.html#a14551e7c53caeaa32b6817ccafc6af0e">More...</a><br /></td></tr>
|
|
<tr class="separator:a14551e7c53caeaa32b6817ccafc6af0e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a827ebc5b43e1cba9b5b7eb4d5ebcd4bd"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1Instance.html#a827ebc5b43e1cba9b5b7eb4d5ebcd4bd">Instance</a> (<a class="el" href="classmastodonpp_1_1Instance.html">Instance</a> &&other) noexcept=delete</td></tr>
|
|
<tr class="memdesc:a827ebc5b43e1cba9b5b7eb4d5ebcd4bd"><td class="mdescLeft"> </td><td class="mdescRight">Move constructor. <a href="classmastodonpp_1_1Instance.html#a827ebc5b43e1cba9b5b7eb4d5ebcd4bd">More...</a><br /></td></tr>
|
|
<tr class="separator:a827ebc5b43e1cba9b5b7eb4d5ebcd4bd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adec12eb92831f3530f55c507a33446be"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1Instance.html#adec12eb92831f3530f55c507a33446be">~Instance</a> () noexcept override=default</td></tr>
|
|
<tr class="memdesc:adec12eb92831f3530f55c507a33446be"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="classmastodonpp_1_1Instance.html#adec12eb92831f3530f55c507a33446be">More...</a><br /></td></tr>
|
|
<tr class="separator:adec12eb92831f3530f55c507a33446be"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a87f44b0dd1fb1b2daebde560847e9da7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmastodonpp_1_1Instance.html">Instance</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1Instance.html#a87f44b0dd1fb1b2daebde560847e9da7">operator=</a> (const <a class="el" href="classmastodonpp_1_1Instance.html">Instance</a> &other)=delete</td></tr>
|
|
<tr class="memdesc:a87f44b0dd1fb1b2daebde560847e9da7"><td class="mdescLeft"> </td><td class="mdescRight">Copy assignment operator. <a href="classmastodonpp_1_1Instance.html#a87f44b0dd1fb1b2daebde560847e9da7">More...</a><br /></td></tr>
|
|
<tr class="separator:a87f44b0dd1fb1b2daebde560847e9da7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af7202e8b775dee75acbccb4cc569a14e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmastodonpp_1_1Instance.html">Instance</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1Instance.html#af7202e8b775dee75acbccb4cc569a14e">operator=</a> (<a class="el" href="classmastodonpp_1_1Instance.html">Instance</a> &&other) noexcept=delete</td></tr>
|
|
<tr class="memdesc:af7202e8b775dee75acbccb4cc569a14e"><td class="mdescLeft"> </td><td class="mdescRight">Move assignment operator. <a href="classmastodonpp_1_1Instance.html#af7202e8b775dee75acbccb4cc569a14e">More...</a><br /></td></tr>
|
|
<tr class="separator:af7202e8b775dee75acbccb4cc569a14e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a921c4b83815c0d98dea983a9409c00ac"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1Instance.html#a921c4b83815c0d98dea983a9409c00ac">copy_connection_properties</a> (<a class="el" href="classmastodonpp_1_1CURLWrapper.html">CURLWrapper</a> &curlwrapper) const</td></tr>
|
|
<tr class="memdesc:a921c4b83815c0d98dea983a9409c00ac"><td class="mdescLeft"> </td><td class="mdescRight">Set the properties of the connection of the calling class up. <a href="classmastodonpp_1_1Instance.html#a921c4b83815c0d98dea983a9409c00ac">More...</a><br /></td></tr>
|
|
<tr class="separator:a921c4b83815c0d98dea983a9409c00ac"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a868aae1fae3ad4060759c1325acb3b62"><td class="memItemLeft" align="right" valign="top">string_view </td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1Instance.html#a868aae1fae3ad4060759c1325acb3b62">get_hostname</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a868aae1fae3ad4060759c1325acb3b62"><td class="mdescLeft"> </td><td class="mdescRight">Returns the hostname. <a href="classmastodonpp_1_1Instance.html#a868aae1fae3ad4060759c1325acb3b62">More...</a><br /></td></tr>
|
|
<tr class="separator:a868aae1fae3ad4060759c1325acb3b62"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a859540ec79ea97c0f76185d9036127bb"><td class="memItemLeft" align="right" valign="top">string_view </td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1Instance.html#a859540ec79ea97c0f76185d9036127bb">get_baseuri</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a859540ec79ea97c0f76185d9036127bb"><td class="mdescLeft"> </td><td class="mdescRight">Returns the base URI. <a href="classmastodonpp_1_1Instance.html#a859540ec79ea97c0f76185d9036127bb">More...</a><br /></td></tr>
|
|
<tr class="separator:a859540ec79ea97c0f76185d9036127bb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3fcd68515b1d07a4003bc09180fff904"><td class="memItemLeft" align="right" valign="top">string_view </td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1Instance.html#a3fcd68515b1d07a4003bc09180fff904">get_access_token</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a3fcd68515b1d07a4003bc09180fff904"><td class="mdescLeft"> </td><td class="mdescRight">Returns the access token. <a href="classmastodonpp_1_1Instance.html#a3fcd68515b1d07a4003bc09180fff904">More...</a><br /></td></tr>
|
|
<tr class="separator:a3fcd68515b1d07a4003bc09180fff904"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3627363d1891a4cfd27f3a27437f4f2e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1Instance.html#a3627363d1891a4cfd27f3a27437f4f2e">set_access_token</a> (const string_view access_token)</td></tr>
|
|
<tr class="memdesc:a3627363d1891a4cfd27f3a27437f4f2e"><td class="mdescLeft"> </td><td class="mdescRight">Set OAuth 2.0 Bearer Access Token. <a href="classmastodonpp_1_1Instance.html#a3627363d1891a4cfd27f3a27437f4f2e">More...</a><br /></td></tr>
|
|
<tr class="separator:a3627363d1891a4cfd27f3a27437f4f2e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3d9f535570e6083b7f37b3c5e42c08dd"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1Instance.html#a3d9f535570e6083b7f37b3c5e42c08dd">get_max_chars</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a3d9f535570e6083b7f37b3c5e42c08dd"><td class="mdescLeft"> </td><td class="mdescRight">Returns the maximum number of characters per post. <a href="classmastodonpp_1_1Instance.html#a3d9f535570e6083b7f37b3c5e42c08dd">More...</a><br /></td></tr>
|
|
<tr class="separator:a3d9f535570e6083b7f37b3c5e42c08dd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab329a0780a1f0581d4771cac4e958157"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1Instance.html#ab329a0780a1f0581d4771cac4e958157">set_proxy</a> (const string_view proxy) override</td></tr>
|
|
<tr class="memdesc:ab329a0780a1f0581d4771cac4e958157"><td class="mdescLeft"> </td><td class="mdescRight">Set the proxy to use. <a href="classmastodonpp_1_1Instance.html#ab329a0780a1f0581d4771cac4e958157">More...</a><br /></td></tr>
|
|
<tr class="separator:ab329a0780a1f0581d4771cac4e958157"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4d594e1365584a05e5a16fc8aea76e9d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmastodonpp_1_1answer__type.html">answer_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1Instance.html#a4d594e1365584a05e5a16fc8aea76e9d">get_nodeinfo</a> ()</td></tr>
|
|
<tr class="memdesc:a4d594e1365584a05e5a16fc8aea76e9d"><td class="mdescLeft"> </td><td class="mdescRight">Returns the NodeInfo of the instance. <a href="classmastodonpp_1_1Instance.html#a4d594e1365584a05e5a16fc8aea76e9d">More...</a><br /></td></tr>
|
|
<tr class="separator:a4d594e1365584a05e5a16fc8aea76e9d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a84b7e4ef6e05f7f7208b557c38b5ad1e"><td class="memItemLeft" align="right" valign="top">vector< string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1Instance.html#a84b7e4ef6e05f7f7208b557c38b5ad1e">get_post_formats</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a84b7e4ef6e05f7f7208b557c38b5ad1e"><td class="mdescLeft"> </td><td class="mdescRight">Returns the allowed mime types for statuses. <a href="classmastodonpp_1_1Instance.html#a84b7e4ef6e05f7f7208b557c38b5ad1e">More...</a><br /></td></tr>
|
|
<tr class="separator:a84b7e4ef6e05f7f7208b557c38b5ad1e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0601321fe7a8b22a42cf6e7d2d817b72"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1Instance.html#a0601321fe7a8b22a42cf6e7d2d817b72">set_cainfo</a> (string_view path) override</td></tr>
|
|
<tr class="memdesc:a0601321fe7a8b22a42cf6e7d2d817b72"><td class="mdescLeft"> </td><td class="mdescRight">Set path to Certificate Authority (CA) bundle. <a href="classmastodonpp_1_1Instance.html#a0601321fe7a8b22a42cf6e7d2d817b72">More...</a><br /></td></tr>
|
|
<tr class="separator:a0601321fe7a8b22a42cf6e7d2d817b72"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3eb6b1a045ad465ec4fd3ad9febc244b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1Instance.html#a3eb6b1a045ad465ec4fd3ad9febc244b">set_useragent</a> (const string_view useragent) override</td></tr>
|
|
<tr class="memdesc:a3eb6b1a045ad465ec4fd3ad9febc244b"><td class="mdescLeft"> </td><td class="mdescRight">Sets the User-Agent. <a href="classmastodonpp_1_1Instance.html#a3eb6b1a045ad465ec4fd3ad9febc244b">More...</a><br /></td></tr>
|
|
<tr class="separator:a3eb6b1a045ad465ec4fd3ad9febc244b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classmastodonpp_1_1CURLWrapper"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classmastodonpp_1_1CURLWrapper')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classmastodonpp_1_1CURLWrapper.html">mastodonpp::CURLWrapper</a></td></tr>
|
|
<tr class="memitem:a736572303fbec7a307514e611e6a468c inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1CURLWrapper.html#a736572303fbec7a307514e611e6a468c">CURLWrapper</a> ()</td></tr>
|
|
<tr class="memdesc:a736572303fbec7a307514e611e6a468c inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="mdescLeft"> </td><td class="mdescRight">Initializes curl and sets up connection. <a href="classmastodonpp_1_1CURLWrapper.html#a736572303fbec7a307514e611e6a468c">More...</a><br /></td></tr>
|
|
<tr class="separator:a736572303fbec7a307514e611e6a468c inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6885296f3807f446963b2f32b298f051 inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1CURLWrapper.html#a6885296f3807f446963b2f32b298f051">CURLWrapper</a> (const <a class="el" href="classmastodonpp_1_1CURLWrapper.html">CURLWrapper</a> &)</td></tr>
|
|
<tr class="memdesc:a6885296f3807f446963b2f32b298f051 inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. Does the same as the Constructor. <a href="classmastodonpp_1_1CURLWrapper.html#a6885296f3807f446963b2f32b298f051">More...</a><br /></td></tr>
|
|
<tr class="separator:a6885296f3807f446963b2f32b298f051 inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4d79b9a4525ac4b4b8954ccc794af0f9 inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1CURLWrapper.html#a4d79b9a4525ac4b4b8954ccc794af0f9">CURLWrapper</a> (<a class="el" href="classmastodonpp_1_1CURLWrapper.html">CURLWrapper</a> &&other) noexcept=delete</td></tr>
|
|
<tr class="memdesc:a4d79b9a4525ac4b4b8954ccc794af0f9 inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="mdescLeft"> </td><td class="mdescRight">Move constructor. <a href="classmastodonpp_1_1CURLWrapper.html#a4d79b9a4525ac4b4b8954ccc794af0f9">More...</a><br /></td></tr>
|
|
<tr class="separator:a4d79b9a4525ac4b4b8954ccc794af0f9 inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a350f7061c9cb54cb5992ae983db3fc19 inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1CURLWrapper.html#a350f7061c9cb54cb5992ae983db3fc19">~CURLWrapper</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a350f7061c9cb54cb5992ae983db3fc19 inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="mdescLeft"> </td><td class="mdescRight">Cleans up curl and connection. <a href="classmastodonpp_1_1CURLWrapper.html#a350f7061c9cb54cb5992ae983db3fc19">More...</a><br /></td></tr>
|
|
<tr class="separator:a350f7061c9cb54cb5992ae983db3fc19 inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5f29b7f4d0b58f70bc96f362cdaa4d0a inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmastodonpp_1_1CURLWrapper.html">CURLWrapper</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1CURLWrapper.html#a5f29b7f4d0b58f70bc96f362cdaa4d0a">operator=</a> (const <a class="el" href="classmastodonpp_1_1CURLWrapper.html">CURLWrapper</a> &other)=delete</td></tr>
|
|
<tr class="memdesc:a5f29b7f4d0b58f70bc96f362cdaa4d0a inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="mdescLeft"> </td><td class="mdescRight">Copy assignment operator. <a href="classmastodonpp_1_1CURLWrapper.html#a5f29b7f4d0b58f70bc96f362cdaa4d0a">More...</a><br /></td></tr>
|
|
<tr class="separator:a5f29b7f4d0b58f70bc96f362cdaa4d0a inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a506cb49c00a63ef4b9d51d0d52c203dc inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmastodonpp_1_1CURLWrapper.html">CURLWrapper</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1CURLWrapper.html#a506cb49c00a63ef4b9d51d0d52c203dc">operator=</a> (<a class="el" href="classmastodonpp_1_1CURLWrapper.html">CURLWrapper</a> &&other) noexcept=delete</td></tr>
|
|
<tr class="memdesc:a506cb49c00a63ef4b9d51d0d52c203dc inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="mdescLeft"> </td><td class="mdescRight">Move assignment operator. <a href="classmastodonpp_1_1CURLWrapper.html#a506cb49c00a63ef4b9d51d0d52c203dc">More...</a><br /></td></tr>
|
|
<tr class="separator:a506cb49c00a63ef4b9d51d0d52c203dc inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2b7aaf03245a0730eeb464802168aded inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="memItemLeft" align="right" valign="top">CURL * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1CURLWrapper.html#a2b7aaf03245a0730eeb464802168aded">get_curl_easy_handle</a> ()</td></tr>
|
|
<tr class="memdesc:a2b7aaf03245a0730eeb464802168aded inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="mdescLeft"> </td><td class="mdescRight">Returns pointer to the CURL easy handle. <a href="classmastodonpp_1_1CURLWrapper.html#a2b7aaf03245a0730eeb464802168aded">More...</a><br /></td></tr>
|
|
<tr class="separator:a2b7aaf03245a0730eeb464802168aded inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a11a543a0821a275dfce1ad7a0e68b17f inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1CURLWrapper.html#a11a543a0821a275dfce1ad7a0e68b17f">escape_url</a> (const string_view url) const</td></tr>
|
|
<tr class="memdesc:a11a543a0821a275dfce1ad7a0e68b17f inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="mdescLeft"> </td><td class="mdescRight">URL encodes the given string. <a href="classmastodonpp_1_1CURLWrapper.html#a11a543a0821a275dfce1ad7a0e68b17f">More...</a><br /></td></tr>
|
|
<tr class="separator:a11a543a0821a275dfce1ad7a0e68b17f inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aed6d09b5c32d71276a851ddf321b5891 inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1CURLWrapper.html#aed6d09b5c32d71276a851ddf321b5891">unescape_url</a> (const string_view url) const</td></tr>
|
|
<tr class="memdesc:aed6d09b5c32d71276a851ddf321b5891 inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="mdescLeft"> </td><td class="mdescRight">URL decodes the given string. <a href="classmastodonpp_1_1CURLWrapper.html#aed6d09b5c32d71276a851ddf321b5891">More...</a><br /></td></tr>
|
|
<tr class="separator:aed6d09b5c32d71276a851ddf321b5891 inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0059ecb78b53c4b3c941b19f8dc897f7 inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1CURLWrapper.html#a0059ecb78b53c4b3c941b19f8dc897f7">setup_connection_properties</a> (string_view proxy, string_view access_token, string_view cainfo, string_view useragent)</td></tr>
|
|
<tr class="memdesc:a0059ecb78b53c4b3c941b19f8dc897f7 inherit pub_methods_classmastodonpp_1_1CURLWrapper"><td class="mdescLeft"> </td><td class="mdescRight">Set some properties of the connection. <a href="classmastodonpp_1_1CURLWrapper.html#a0059ecb78b53c4b3c941b19f8dc897f7">More...</a><br /></td></tr>
|
|
<tr class="separator:a0059ecb78b53c4b3c941b19f8dc897f7 inherit pub_methods_classmastodonpp_1_1CURLWrapper"><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_classmastodonpp_1_1CURLWrapper"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classmastodonpp_1_1CURLWrapper')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classmastodonpp_1_1CURLWrapper.html">mastodonpp::CURLWrapper</a></td></tr>
|
|
<tr class="memitem:adc8808c3fad5397176f6755b09ee0be6 inherit pro_methods_classmastodonpp_1_1CURLWrapper"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmastodonpp_1_1answer__type.html">answer_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1CURLWrapper.html#adc8808c3fad5397176f6755b09ee0be6">make_request</a> (const <a class="el" href="namespacemastodonpp.html#a7d60fc71ad0fb1fbd467b37fe1f1f100">http_method</a> &method, string uri, const <a class="el" href="namespacemastodonpp.html#af8b3b89118adeccc71c54dfd36c987f6">parametermap</a> &parameters)</td></tr>
|
|
<tr class="memdesc:adc8808c3fad5397176f6755b09ee0be6 inherit pro_methods_classmastodonpp_1_1CURLWrapper"><td class="mdescLeft"> </td><td class="mdescRight">Make a HTTP request. <a href="classmastodonpp_1_1CURLWrapper.html#adc8808c3fad5397176f6755b09ee0be6">More...</a><br /></td></tr>
|
|
<tr class="separator:adc8808c3fad5397176f6755b09ee0be6 inherit pro_methods_classmastodonpp_1_1CURLWrapper"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a04b3919cfb38716c5a032337e442db95 inherit pro_methods_classmastodonpp_1_1CURLWrapper"><td class="memItemLeft" align="right" valign="top">string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1CURLWrapper.html#a04b3919cfb38716c5a032337e442db95">get_buffer</a> ()</td></tr>
|
|
<tr class="memdesc:a04b3919cfb38716c5a032337e442db95 inherit pro_methods_classmastodonpp_1_1CURLWrapper"><td class="mdescLeft"> </td><td class="mdescRight">Returns a reference to the buffer libcurl writes into. <a href="classmastodonpp_1_1CURLWrapper.html#a04b3919cfb38716c5a032337e442db95">More...</a><br /></td></tr>
|
|
<tr class="separator:a04b3919cfb38716c5a032337e442db95 inherit pro_methods_classmastodonpp_1_1CURLWrapper"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a892a4fc3d048798fa8e2584545b91861 inherit pro_methods_classmastodonpp_1_1CURLWrapper"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1CURLWrapper.html#a892a4fc3d048798fa8e2584545b91861">cancel_stream</a> ()</td></tr>
|
|
<tr class="memdesc:a892a4fc3d048798fa8e2584545b91861 inherit pro_methods_classmastodonpp_1_1CURLWrapper"><td class="mdescLeft"> </td><td class="mdescRight">Cancel the stream. <a href="classmastodonpp_1_1CURLWrapper.html#a892a4fc3d048798fa8e2584545b91861">More...</a><br /></td></tr>
|
|
<tr class="separator:a892a4fc3d048798fa8e2584545b91861 inherit pro_methods_classmastodonpp_1_1CURLWrapper"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a94aba6daedea376ccc20e5c983bd3358 inherit pro_methods_classmastodonpp_1_1CURLWrapper"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1CURLWrapper.html#a94aba6daedea376ccc20e5c983bd3358">set_access_token</a> (string_view access_token)</td></tr>
|
|
<tr class="memdesc:a94aba6daedea376ccc20e5c983bd3358 inherit pro_methods_classmastodonpp_1_1CURLWrapper"><td class="mdescLeft"> </td><td class="mdescRight">Set OAuth 2.0 Bearer Access Token. <a href="classmastodonpp_1_1CURLWrapper.html#a94aba6daedea376ccc20e5c983bd3358">More...</a><br /></td></tr>
|
|
<tr class="separator:a94aba6daedea376ccc20e5c983bd3358 inherit pro_methods_classmastodonpp_1_1CURLWrapper"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pro_attribs_classmastodonpp_1_1CURLWrapper"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classmastodonpp_1_1CURLWrapper')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classmastodonpp_1_1CURLWrapper.html">mastodonpp::CURLWrapper</a></td></tr>
|
|
<tr class="memitem:af7e18dc7c3bdc1c58bc93a46bf00866a inherit pro_attribs_classmastodonpp_1_1CURLWrapper"><td class="memItemLeft" align="right" valign="top">mutex </td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1CURLWrapper.html#af7e18dc7c3bdc1c58bc93a46bf00866a">_buffer_mutex</a></td></tr>
|
|
<tr class="memdesc:af7e18dc7c3bdc1c58bc93a46bf00866a inherit pro_attribs_classmastodonpp_1_1CURLWrapper"><td class="mdescLeft"> </td><td class="mdescRight">Mutex for <a class="el" href="classmastodonpp_1_1CURLWrapper.html#a04b3919cfb38716c5a032337e442db95" title="Returns a reference to the buffer libcurl writes into.">get_buffer</a> a.k.a. _curl_buffer_body. <a href="classmastodonpp_1_1CURLWrapper.html#af7e18dc7c3bdc1c58bc93a46bf00866a">More...</a><br /></td></tr>
|
|
<tr class="separator:af7e18dc7c3bdc1c58bc93a46bf00866a inherit pro_attribs_classmastodonpp_1_1CURLWrapper"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Holds the access data of an instance. </p>
|
|
<p><a class="el" href="classmastodonpp_1_1Instance.html" title="Holds the access data of an instance.">Instance</a>s are needed to initialize <a class="el" href="classmastodonpp_1_1Connection.html" title="Represents a connection to an instance. Used for requests.">Connection</a>s. All properties you set here (with <a class="el" href="classmastodonpp_1_1Instance.html#ab329a0780a1f0581d4771cac4e958157" title="Set the proxy to use.">set_proxy()</a>, <a class="el" href="classmastodonpp_1_1Instance.html#a3eb6b1a045ad465ec4fd3ad9febc244b" title="Sets the User-Agent.">set_useragent()</a> and so on) are copied to every <a class="el" href="classmastodonpp_1_1Connection.html" title="Represents a connection to an instance. Used for requests.">Connection</a> you initialize afterwards.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>0.1.0 </dd></dl>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a21b859e2b9b5c6f48e8d0a194a659888"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a21b859e2b9b5c6f48e8d0a194a659888">◆ </a></span>Instance() <span class="overload">[1/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">mastodonpp::Instance::Instance </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string_view </td>
|
|
<td class="paramname"><em>hostname</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string_view </td>
|
|
<td class="paramname"><em>access_token</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</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>Construct a new <a class="el" href="classmastodonpp_1_1Instance.html" title="Holds the access data of an instance.">Instance</a> object. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">hostname</td><td>The hostname of the instance. </td></tr>
|
|
<tr><td class="paramname">access_token</td><td>Your access token.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section since"><dt>Since</dt><dd>0.1.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a14551e7c53caeaa32b6817ccafc6af0e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a14551e7c53caeaa32b6817ccafc6af0e">◆ </a></span>Instance() <span class="overload">[2/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">mastodonpp::Instance::Instance </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classmastodonpp_1_1Instance.html">Instance</a> & </td>
|
|
<td class="paramname"><em>other</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Copy constructor. A new <a class="el" href="classmastodonpp_1_1CURLWrapper.html" title="Handles the details of network connections.">CURLWrapper</a> is constructed. </p>
|
|
<dl class="section since"><dt>Since</dt><dd>0.5.2 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a827ebc5b43e1cba9b5b7eb4d5ebcd4bd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a827ebc5b43e1cba9b5b7eb4d5ebcd4bd">◆ </a></span>Instance() <span class="overload">[3/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">mastodonpp::Instance::Instance </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classmastodonpp_1_1Instance.html">Instance</a> && </td>
|
|
<td class="paramname"><em>other</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">delete</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Move constructor. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adec12eb92831f3530f55c507a33446be"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adec12eb92831f3530f55c507a33446be">◆ </a></span>~Instance()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">mastodonpp::Instance::~Instance </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">default</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Destructor. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a921c4b83815c0d98dea983a9409c00ac"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a921c4b83815c0d98dea983a9409c00ac">◆ </a></span>copy_connection_properties()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void mastodonpp::Instance::copy_connection_properties </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classmastodonpp_1_1CURLWrapper.html">CURLWrapper</a> & </td>
|
|
<td class="paramname"><em>curlwrapper</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the properties of the connection of the calling class up. </p>
|
|
<p>Meant for internal use. This aligns the properties of the connection of the calling class with the properties of connection of this class.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">curlwrapper</td><td>The <a class="el" href="classmastodonpp_1_1CURLWrapper.html" title="Handles the details of network connections.">CURLWrapper</a> parent of the calling class.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section since"><dt>Since</dt><dd>0.3.0 </dd></dl>
|
|
<div class="fragment"><div class="line"><a name="l00091"></a><span class="lineno"> 91</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><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a3fcd68515b1d07a4003bc09180fff904"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3fcd68515b1d07a4003bc09180fff904">◆ </a></span>get_access_token()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string_view mastodonpp::Instance::get_access_token </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">inline</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the access token. </p>
|
|
<dl class="section since"><dt>Since</dt><dd>0.1.0 </dd></dl>
|
|
<div class="fragment"><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><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a859540ec79ea97c0f76185d9036127bb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a859540ec79ea97c0f76185d9036127bb">◆ </a></span>get_baseuri()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string_view mastodonpp::Instance::get_baseuri </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">inline</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the base URI. </p>
|
|
<p>The base URI is “https://” + the hostname.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>0.1.0 </dd></dl>
|
|
<div class="fragment"><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><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a868aae1fae3ad4060759c1325acb3b62"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a868aae1fae3ad4060759c1325acb3b62">◆ </a></span>get_hostname()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string_view mastodonpp::Instance::get_hostname </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">inline</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the hostname. </p>
|
|
<dl class="section since"><dt>Since</dt><dd>0.1.0 </dd></dl>
|
|
<div class="fragment"><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><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a3d9f535570e6083b7f37b3c5e42c08dd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3d9f535570e6083b7f37b3c5e42c08dd">◆ </a></span>get_max_chars()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint64_t mastodonpp::Instance::get_max_chars </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the maximum number of characters per post. </p>
|
|
<p>Queries <code>/api/v1/instance</code> for ‘max_toot_chars’. If the instance doesn't support it, the limit is assumed to be 500.</p>
|
|
<p>After the first call, the value is saved internally. Subsequent calls return the saved value.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>0.1.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4d594e1365584a05e5a16fc8aea76e9d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4d594e1365584a05e5a16fc8aea76e9d">◆ </a></span>get_nodeinfo()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structmastodonpp_1_1answer__type.html">answer_type</a> mastodonpp::Instance::get_nodeinfo </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the NodeInfo of the instance. </p>
|
|
<p>Attempts to download the <a href="https://nodeinfo.diaspora.software/protocol.html">NodeInfo</a> of the instance and returns it. Not every instance has it.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>0.3.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a84b7e4ef6e05f7f7208b557c38b5ad1e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a84b7e4ef6e05f7f7208b557c38b5ad1e">◆ </a></span>get_post_formats()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">vector<string> mastodonpp::Instance::get_post_formats </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the allowed mime types for statuses. </p>
|
|
<p>Extracts <code>metadata.postFormats</code> from NodeInfo. If none can be found, returns <code>{"text/plain"}</code>.</p>
|
|
<p>After the first call, the value is saved internally. Subsequent calls return the saved value.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>0.3.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a87f44b0dd1fb1b2daebde560847e9da7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a87f44b0dd1fb1b2daebde560847e9da7">◆ </a></span>operator=() <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"><a class="el" href="classmastodonpp_1_1Instance.html">Instance</a>& mastodonpp::Instance::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classmastodonpp_1_1Instance.html">Instance</a> & </td>
|
|
<td class="paramname"><em>other</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Copy assignment operator. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af7202e8b775dee75acbccb4cc569a14e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af7202e8b775dee75acbccb4cc569a14e">◆ </a></span>operator=() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classmastodonpp_1_1Instance.html">Instance</a>& mastodonpp::Instance::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classmastodonpp_1_1Instance.html">Instance</a> && </td>
|
|
<td class="paramname"><em>other</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">delete</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Move assignment operator. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3627363d1891a4cfd27f3a27437f4f2e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3627363d1891a4cfd27f3a27437f4f2e">◆ </a></span>set_access_token()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void mastodonpp::Instance::set_access_token </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const string_view </td>
|
|
<td class="paramname"><em>access_token</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set OAuth 2.0 Bearer Access Token. </p>
|
|
<p>Sets also the access token for all <a class="el" href="classmastodonpp_1_1Connection.html" title="Represents a connection to an instance. Used for requests.">Connection</a>s that are initialized with this <a class="el" href="classmastodonpp_1_1Instance.html" title="Holds the access data of an instance.">Instance</a> afterwards.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>0.1.0 </dd></dl>
|
|
<div class="fragment"><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="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><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a0601321fe7a8b22a42cf6e7d2d817b72"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0601321fe7a8b22a42cf6e7d2d817b72">◆ </a></span>set_cainfo()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void mastodonpp::Instance::set_cainfo </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string_view </td>
|
|
<td class="paramname"><em>path</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set path to Certificate Authority (CA) bundle. </p>
|
|
<p>Sets also the CA info for all <a class="el" href="classmastodonpp_1_1Connection.html" title="Represents a connection to an instance. Used for requests.">Connection</a>s that are initialized with this <a class="el" href="classmastodonpp_1_1Instance.html" title="Holds the access data of an instance.">Instance</a> afterwards.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>0.3.0 </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="classmastodonpp_1_1CURLWrapper.html#af3f2bd4dea7c289d590fe19889360444">mastodonpp::CURLWrapper</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00199"></a><span class="lineno"> 199</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="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><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="ab329a0780a1f0581d4771cac4e958157"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab329a0780a1f0581d4771cac4e958157">◆ </a></span>set_proxy()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void mastodonpp::Instance::set_proxy </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const string_view </td>
|
|
<td class="paramname"><em>proxy</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the proxy to use. </p>
|
|
<p>See <a href="https://curl.haxx.se/libcurl/c/CURLOPT_PROXY.html">CURLOPT_PROXY(3)</a>.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">proxy</td><td>Examples: "socks4a://127.0.0.1:9050", "http://[::1]:3128".</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section since"><dt>Since</dt><dd>0.1.0</dd></dl>
|
|
<p>Sets also the proxy for all <a class="el" href="classmastodonpp_1_1Connection.html" title="Represents a connection to an instance. Used for requests.">Connection</a>s that are initialized with this <a class="el" href="classmastodonpp_1_1Instance.html" title="Holds the access data of an instance.">Instance</a> afterwards. </p>
|
|
|
|
<p>Reimplemented from <a class="el" href="classmastodonpp_1_1CURLWrapper.html#a1564a42794ef7a9d170b725063ef504d">mastodonpp::CURLWrapper</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00161"></a><span class="lineno"> 161</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="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><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a3eb6b1a045ad465ec4fd3ad9febc244b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3eb6b1a045ad465ec4fd3ad9febc244b">◆ </a></span>set_useragent()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void mastodonpp::Instance::set_useragent </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const string_view </td>
|
|
<td class="paramname"><em>useragent</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the User-Agent. </p>
|
|
<p>Sets also the User-Agent for all <a class="el" href="classmastodonpp_1_1Connection.html" title="Represents a connection to an instance. Used for requests.">Connection</a>s that are initialized with this <a class="el" href="classmastodonpp_1_1Instance.html" title="Holds the access data of an instance.">Instance</a> afterwards.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>0.3.0 </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="classmastodonpp_1_1CURLWrapper.html#ae3b1445f9b94b1f7677d3cac6d538612">mastodonpp::CURLWrapper</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00213"></a><span class="lineno"> 213</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="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><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>include/<a class="el" href="instance_8hpp_source.html">instance.hpp</a></li>
|
|
</ul>
|
|
</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>
|