2020-01-03 11:14:21 +01:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" >
< head >
< meta http-equiv = "Content-Type" content = "text/xhtml;charset=UTF-8" / >
< meta http-equiv = "X-UA-Compatible" content = "IE=9" / >
< meta name = "generator" content = "Doxygen 1.8.16" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
< title > mastodonpp: mastodonpp::API 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.0.0< / span >
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
< 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');
/* @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 >
2020-01-04 11:40:17 +01:00
< li class = "navelem" > < a class = "el" href = "namespacemastodonpp.html" > mastodonpp< / a > < / li > < li class = "navelem" > < a class = "el" href = "classmastodonpp_1_1API.html" > API< / a > < / li > < / ul >
2020-01-03 11:14:21 +01:00
< / div >
< / div > <!-- top -->
< div class = "header" >
< div class = "summary" >
2020-01-04 11:40:17 +01:00
< a href = "#pub-types" > Public Types< / a > |
2020-01-03 11:14:21 +01:00
< a href = "#pub-methods" > Public Member Functions< / a > |
< a href = "classmastodonpp_1_1API-members.html" > List of all members< / a > < / div >
< div class = "headertitle" >
< div class = "title" > mastodonpp::API Class Reference< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
2020-01-04 11:40:17 +01:00
< p > Holds < a class = "el" href = "classmastodonpp_1_1API.html" title = "Holds API endpoints." > API< / a > endpoints.
2020-01-03 11:14:21 +01:00
< a href = "classmastodonpp_1_1API.html#details" > More...< / a > < / p >
2020-01-04 11:40:17 +01:00
< p > < code > #include < < a class = "el" href = "api_8hpp_source.html" > api.hpp< / a > > < / code > < / p >
2020-01-03 11:14:21 +01:00
< table class = "memberdecls" >
2020-01-04 11:40:17 +01:00
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "pub-types" > < / a >
Public Types< / h2 > < / td > < / tr >
< tr class = "memitem:aee8f590426914a36f948dafa78e330f2" > < td class = "memItemLeft" align = "right" valign = "top" > enum   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classmastodonpp_1_1API.html#aee8f590426914a36f948dafa78e330f2" > v1< / a > { < b > instance< / b >
}< / td > < / tr >
< tr class = "memdesc:aee8f590426914a36f948dafa78e330f2" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > An enumeration of all v1 < a class = "el" href = "classmastodonpp_1_1API.html" title = "Holds API endpoints." > API< / a > endpoints. < a href = "classmastodonpp_1_1API.html#aee8f590426914a36f948dafa78e330f2" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:aee8f590426914a36f948dafa78e330f2" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a67ba7c7a8d94ec7905e45466255648ba" > < td class = "memItemLeft" align = "right" valign = "top" > enum   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classmastodonpp_1_1API.html#a67ba7c7a8d94ec7905e45466255648ba" > v2< / a > { < b > search< / b >
}< / td > < / tr >
< tr class = "memdesc:a67ba7c7a8d94ec7905e45466255648ba" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > An enumeration of all v2 < a class = "el" href = "classmastodonpp_1_1API.html" title = "Holds API endpoints." > API< / a > endpoints. < a href = "classmastodonpp_1_1API.html#a67ba7c7a8d94ec7905e45466255648ba" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:a67ba7c7a8d94ec7905e45466255648ba" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:afab8f6d794dbe28dde47d39b53822e82" > < td class = "memItemLeft" align = "right" valign = "top" > using  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classmastodonpp_1_1API.html#afab8f6d794dbe28dde47d39b53822e82" > endpoint_type< / a > = variant< < a class = "el" href = "classmastodonpp_1_1API.html#aee8f590426914a36f948dafa78e330f2" > v1< / a > , < a class = "el" href = "classmastodonpp_1_1API.html#a67ba7c7a8d94ec7905e45466255648ba" > v2< / a > > < / td > < / tr >
< tr class = "memdesc:afab8f6d794dbe28dde47d39b53822e82" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Type for endpoints. Either < a class = "el" href = "classmastodonpp_1_1API.html#aee8f590426914a36f948dafa78e330f2" title = "An enumeration of all v1 API endpoints." > API::v1< / a > or < a class = "el" href = "classmastodonpp_1_1API.html#a67ba7c7a8d94ec7905e45466255648ba" title = "An enumeration of all v2 API endpoints." > API::v2< / a > . < a href = "classmastodonpp_1_1API.html#afab8f6d794dbe28dde47d39b53822e82" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:afab8f6d794dbe28dde47d39b53822e82" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table > < table class = "memberdecls" >
2020-01-03 11:14:21 +01:00
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "pub-methods" > < / a >
Public Member Functions< / h2 > < / td > < / tr >
2020-01-04 11:40:17 +01:00
< tr class = "memitem:ab119ba2638c43388423e9c01c14c9246" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classmastodonpp_1_1API.html#ab119ba2638c43388423e9c01c14c9246" > API< / a > (< a class = "el" href = "classmastodonpp_1_1API.html#afab8f6d794dbe28dde47d39b53822e82" > endpoint_type< / a > & endpoint)< / td > < / tr >
< tr class = "memdesc:ab119ba2638c43388423e9c01c14c9246" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Constructs an < a class = "el" href = "classmastodonpp_1_1API.html" title = "Holds API endpoints." > API< / a > object. You should never need this. < a href = "classmastodonpp_1_1API.html#ab119ba2638c43388423e9c01c14c9246" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ab119ba2638c43388423e9c01c14c9246" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a0dc773350528fe78be20cf57d3109a9c" > < td class = "memItemLeft" align = "right" valign = "top" > string  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classmastodonpp_1_1API.html#a0dc773350528fe78be20cf57d3109a9c" > to_string< / a > () const< / td > < / tr >
< tr class = "memdesc:a0dc773350528fe78be20cf57d3109a9c" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Convert < a class = "el" href = "classmastodonpp_1_1API.html#afab8f6d794dbe28dde47d39b53822e82" title = "Type for endpoints. Either API::v1 or API::v2." > endpoint_type< / a > to string. < a href = "classmastodonpp_1_1API.html#a0dc773350528fe78be20cf57d3109a9c" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:a0dc773350528fe78be20cf57d3109a9c" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2020-01-03 11:14:21 +01:00
< / table >
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Detailed Description< / h2 >
2020-01-04 11:40:17 +01:00
< div class = "textblock" > < p > Holds < a class = "el" href = "classmastodonpp_1_1API.html" title = "Holds API endpoints." > API< / a > endpoints. < / p >
2020-01-03 11:14:21 +01:00
< dl class = "section since" > < dt > Since< / dt > < dd > 0.1.0 < / dd > < / dl >
2020-01-04 11:40:17 +01:00
< / div > < h2 class = "groupheader" > Member Typedef Documentation< / h2 >
< a id = "afab8f6d794dbe28dde47d39b53822e82" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#afab8f6d794dbe28dde47d39b53822e82" > ◆ < / a > < / span > endpoint_type< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > using < a class = "el" href = "classmastodonpp_1_1API.html#afab8f6d794dbe28dde47d39b53822e82" > mastodonpp::API::endpoint_type< / a > = variant< < a class = "el" href = "classmastodonpp_1_1API.html#aee8f590426914a36f948dafa78e330f2" > v1< / a > ,< a class = "el" href = "classmastodonpp_1_1API.html#a67ba7c7a8d94ec7905e45466255648ba" > v2< / a > > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Type for endpoints. Either < a class = "el" href = "classmastodonpp_1_1API.html#aee8f590426914a36f948dafa78e330f2" title = "An enumeration of all v1 API endpoints." > API::v1< / a > or < a class = "el" href = "classmastodonpp_1_1API.html#a67ba7c7a8d94ec7905e45466255648ba" title = "An enumeration of all v2 API endpoints." > API::v2< / a > . < / p >
< dl class = "section since" > < dt > Since< / dt > < dd > 0.1.0 < / dd > < / dl >
< / div >
< / div >
< h2 class = "groupheader" > Member Enumeration Documentation< / h2 >
< a id = "aee8f590426914a36f948dafa78e330f2" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#aee8f590426914a36f948dafa78e330f2" > ◆ < / a > < / span > v1< / h2 >
2020-01-03 11:14:21 +01:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
2020-01-04 11:40:17 +01:00
< td class = "memname" > enum < a class = "el" href = "classmastodonpp_1_1API.html#aee8f590426914a36f948dafa78e330f2" > mastodonpp::API::v1< / a > < / td >
2020-01-03 11:14:21 +01:00
< / tr >
2020-01-04 11:40:17 +01:00
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > strong< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > An enumeration of all v1 < a class = "el" href = "classmastodonpp_1_1API.html" title = "Holds API endpoints." > API< / a > endpoints. < / p >
< p > The original < code > /< / code > are substituted with < code > _< / code > .< / p >
< dl class = "section since" > < dt > Since< / dt > < dd > 0.1.0 < / dd > < / dl >
< div class = "fragment" > < div class = "line" > < a name = "l00046" > < / a > < span class = "lineno" > 46< / span >   {< / div >
< div class = "line" > < a name = "l00047" > < / a > < span class = "lineno" > 47< / span >   instance< / div >
< div class = "line" > < a name = "l00048" > < / a > < span class = "lineno" > 48< / span >   };< / div >
< / div > <!-- fragment -->
< / div >
< / div >
< a id = "a67ba7c7a8d94ec7905e45466255648ba" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a67ba7c7a8d94ec7905e45466255648ba" > ◆ < / a > < / span > v2< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
2020-01-03 11:14:21 +01:00
< tr >
2020-01-04 11:40:17 +01:00
< td class = "memname" > enum < a class = "el" href = "classmastodonpp_1_1API.html#a67ba7c7a8d94ec7905e45466255648ba" > mastodonpp::API::v2< / a > < / td >
2020-01-03 11:14:21 +01:00
< / tr >
2020-01-04 11:40:17 +01:00
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > strong< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > An enumeration of all v2 < a class = "el" href = "classmastodonpp_1_1API.html" title = "Holds API endpoints." > API< / a > endpoints. < / p >
< p > The original < code > /< / code > are substituted with < code > _< / code > .< / p >
< dl class = "section since" > < dt > Since< / dt > < dd > 0.1.0 < / dd > < / dl >
< div class = "fragment" > < div class = "line" > < a name = "l00058" > < / a > < span class = "lineno" > 58< / span >   {< / div >
< div class = "line" > < a name = "l00059" > < / a > < span class = "lineno" > 59< / span >   search< / div >
< div class = "line" > < a name = "l00060" > < / a > < span class = "lineno" > 60< / span >   };< / div >
< / div > <!-- fragment -->
< / div >
< / div >
< h2 class = "groupheader" > Constructor & Destructor Documentation< / h2 >
< a id = "ab119ba2638c43388423e9c01c14c9246" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ab119ba2638c43388423e9c01c14c9246" > ◆ < / a > < / span > API()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
2020-01-03 11:14:21 +01:00
< tr >
2020-01-04 11:40:17 +01:00
< td class = "memname" > mastodonpp::API::API < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "classmastodonpp_1_1API.html#afab8f6d794dbe28dde47d39b53822e82" > endpoint_type< / a > &   < / td >
< td class = "paramname" > < em > endpoint< / em > < / td > < td > )< / td >
2020-01-03 11:14:21 +01:00
< 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" >
2020-01-04 11:40:17 +01:00
< p > Constructs an < a class = "el" href = "classmastodonpp_1_1API.html" title = "Holds API endpoints." > API< / a > object. You should never need this. < / p >
< p > This constructor exists to hide away the class members, which are used internally.< / p >
< dl class = "section since" > < dt > Since< / dt > < dd > 0.1.0 < / dd > < / dl >
< div class = "fragment" > < div class = "line" > < a name = "l00031" > < / a > < span class = "lineno" > 31< / span >   : _endpoint{move(endpoint)}< / div >
< div class = "line" > < a name = "l00032" > < / a > < span class = "lineno" > 32< / span >   {}< / div >
< / div > <!-- fragment -->
< / div >
< / div >
< h2 class = "groupheader" > Member Function Documentation< / h2 >
< a id = "a0dc773350528fe78be20cf57d3109a9c" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a0dc773350528fe78be20cf57d3109a9c" > ◆ < / a > < / span > to_string()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > string mastodonpp::API::to_string < / td >
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > const< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Convert < a class = "el" href = "classmastodonpp_1_1API.html#afab8f6d794dbe28dde47d39b53822e82" title = "Type for endpoints. Either API::v1 or API::v2." > endpoint_type< / a > to string. < / p >
2020-01-03 11:14:21 +01:00
< dl class = "section since" > < dt > Since< / dt > < dd > 0.1.0 < / dd > < / dl >
2020-01-04 11:40:17 +01:00
< div class = "fragment" > < div class = "line" > < a name = "l00035" > < / a > < span class = "lineno" > 35< / span >   {< / div >
< div class = "line" > < a name = "l00036" > < / a > < span class = "lineno" > 36< / span >   < span class = "keyword" > static< / span > < span class = "keyword" > const< / span > map< endpoint_type,string_view> endpoint_map< / div >
< div class = "line" > < a name = "l00037" > < / a > < span class = "lineno" > 37< / span >   {< / div >
< div class = "line" > < a name = "l00038" > < / a > < span class = "lineno" > 38< / span >   {v1::instance, < span class = "stringliteral" > " /api/v1/instance" < / span > },< / div >
< div class = "line" > < a name = "l00039" > < / a > < span class = "lineno" > 39< / span >   {v2::search, < span class = "stringliteral" > " /api/v2/search" < / span > }< / div >
< div class = "line" > < a name = "l00040" > < / a > < span class = "lineno" > 40< / span >   };< / div >
< div class = "line" > < a name = "l00041" > < / a > < span class = "lineno" > 41< / span >   < span class = "keywordflow" > return< / span > endpoint_map.at(_endpoint).data();< / div >
< div class = "line" > < a name = "l00042" > < / a > < span class = "lineno" > 42< / span >   }< / div >
2020-01-03 11:14:21 +01:00
< / div > <!-- fragment -->
< / div >
< / div >
< hr / > The documentation for this class was generated from the following files:< ul >
2020-01-04 11:40:17 +01:00
< li > include/< a class = "el" href = "api_8hpp_source.html" > api.hpp< / a > < / li >
< li > src/api.cpp< / li >
2020-01-03 11:14:21 +01:00
< / ul >
< / div > <!-- contents -->
<!-- start footer part -->
< hr class = "footer" / > < address class = "footer" > < small >
Generated by   < a href = "http://www.doxygen.org/index.html" >
< img class = "footer" src = "doxygen.png" alt = "doxygen" / >
< / a > 1.8.16
< / small > < / address >
< / body >
< / html >
