66 lines
13 KiB
HTML
66 lines
13 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.8.15"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>mastodon-cpp: src/types.hpp Source File</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">mastodon-cpp
|
|
 <span id="projectnumber">0.110.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.15 -->
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',false,false,'search.php','Search');
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">types.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 mastodon-cpp.</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright © 2019 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 MASTODON_CPP_TYPES_HPP</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#define MASTODON_CPP_TYPES_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 <string></span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <map></span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <vector></span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">using</span> std::string;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">using</span> std::vector;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">namespace </span><a class="code" href="namespaceMastodon.html">Mastodon</a></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> {</div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="structMastodon_1_1param.html"> 37</a></span>  <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structMastodon_1_1param.html">param</a></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  {</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordtype">string</span> key;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  vector<string> values;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keyword">operator</span> <span class="keyword">const</span> string() <span class="keyword">const</span>;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  } <a class="code" href="namespaceMastodon.html#a3f8ffec5a51251879486cf91277760b8">param</a>;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="structMastodon_1_1parameters.html"> 62</a></span>  <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structMastodon_1_1parameters.html">parameters</a> : <span class="keyword">public</span> vector<param></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  {</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">using</span> vector<param>::vector;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keyword">const</span> std::vector<param>::const_iterator <a class="code" href="structMastodon_1_1parameters.html#ac58ec4af7e4d238d72ff3d139c09997a">find</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &key) <span class="keyword">const</span>;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  } <a class="code" href="namespaceMastodon.html#aaf95922e677cfc5b25eb56b4b6406d51">parameters</a>;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div><div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="namespaceMastodon.html#a1b4c13dfd9ccc43a2328d99a93b34452"> 87</a></span>  <span class="keyword">enum class</span> <a class="code" href="namespaceMastodon.html#a1b4c13dfd9ccc43a2328d99a93b34452">http_method</a></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  {</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  GET,</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  PATCH,</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  POST,</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  PUT,</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  DELETE,</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  GET_STREAM</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  };</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keyword">enum class</span> error</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  {</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  OK = 0,</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  INVALID_ARGUMENT = 1,</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  URL_CHANGED = 10,</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  CONNECTION_TIMEOUT = 11,</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  CONNECTION_REFUSED = 12,</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  DNS = 13,</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  ENCRYPTION = 14,</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  UNKNOWN = 127</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  };</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> }</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="preprocessor">#endif // MASTODON_CPP_TYPES_HPP</span></div><div class="ttc" id="namespaceMastodon_html_a3f8ffec5a51251879486cf91277760b8"><div class="ttname"><a href="namespaceMastodon.html#a3f8ffec5a51251879486cf91277760b8">Mastodon::param</a></div><div class="ttdeci">struct Mastodon::param param</div><div class="ttdoc">A single parameter.</div></div>
|
|
<div class="ttc" id="structMastodon_1_1parameters_html"><div class="ttname"><a href="structMastodon_1_1parameters.html">Mastodon::parameters</a></div><div class="ttdoc">Vector of Mastodon::param, used for passing parameters in calls.</div><div class="ttdef"><b>Definition:</b> types.hpp:62</div></div>
|
|
<div class="ttc" id="structMastodon_1_1parameters_html_ac58ec4af7e4d238d72ff3d139c09997a"><div class="ttname"><a href="structMastodon_1_1parameters.html#ac58ec4af7e4d238d72ff3d139c09997a">Mastodon::parameters::find</a></div><div class="ttdeci">const std::vector< param >::const_iterator find(const string &key) const</div><div class="ttdoc">Get iterator to element with key.</div><div class="ttdef"><b>Definition:</b> types.cpp:27</div></div>
|
|
<div class="ttc" id="namespaceMastodon_html_a1b4c13dfd9ccc43a2328d99a93b34452"><div class="ttname"><a href="namespaceMastodon.html#a1b4c13dfd9ccc43a2328d99a93b34452">Mastodon::http_method</a></div><div class="ttdeci">http_method</div><div class="ttdoc">HTTP methods. Used in API calls.</div><div class="ttdef"><b>Definition:</b> types.hpp:87</div></div>
|
|
<div class="ttc" id="namespaceMastodon_html_aaf95922e677cfc5b25eb56b4b6406d51"><div class="ttname"><a href="namespaceMastodon.html#aaf95922e677cfc5b25eb56b4b6406d51">Mastodon::parameters</a></div><div class="ttdeci">Mastodon::parameters parameters</div><div class="ttdoc">Vector of Mastodon::param, used for passing parameters in calls.</div></div>
|
|
<div class="ttc" id="structMastodon_1_1param_html"><div class="ttname"><a href="structMastodon_1_1param.html">Mastodon::param</a></div><div class="ttdoc">A single parameter.</div><div class="ttdef"><b>Definition:</b> types.hpp:37</div></div>
|
|
<div class="ttc" id="namespaceMastodon_html"><div class="ttname"><a href="namespaceMastodon.html">Mastodon</a></div><div class="ttdoc">Collection of things to interface with server software that implements the Mastodon API.</div><div class="ttdef"><b>Definition:</b> mastodon-cpp.hpp:47</div></div>
|
|
</div><!-- fragment --></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.15
|
|
</small></address>
|
|
</body>
|
|
</html>
|