69 lines
16 KiB
HTML
69 lines
16 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.14"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>mastodon-cpp: src/easy/entities/pushsubscription.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.17.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.14 -->
|
|
<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><li class="navelem"><a class="el" href="dir_9d328871126a6a5820f3cd5c0c41741e.html">easy</a></li><li class="navelem"><a class="el" href="dir_e526f556af6ddef7955f0f6556f0f4d0.html">entities</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">pushsubscription.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 © 2018 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 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 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 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_EASY_PUSHSUBSCRIPTION_HPP</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#define MASTODON_CPP_EASY_PUSHSUBSCRIPTION_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 <cstdint></span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <map></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="comment">// If we are compiling mastodon-cpp, use another include path</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#ifdef MASTODON_CPP</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor"> #include "mastodon-cpp.hpp"</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor"> #include "easy/easy.hpp"</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor"> #include <mastodon-cpp/mastodon-cpp.hpp></span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor"> #include <mastodon-cpp/easy/easy.hpp></span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">using</span> std::string;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">using</span> std::uint_fast64_t;</div><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">namespace </span><a class="code" href="namespaceMastodon.html">Mastodon</a></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> {</div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="classMastodon_1_1Easy_1_1PushSubscription.html"> 43</a></span>  <span class="keyword">class </span><a class="code" href="classMastodon_1_1Easy_1_1PushSubscription.html">Easy::PushSubscription</a> : <span class="keyword">public</span> <a class="code" href="classMastodon_1_1Easy_1_1Entity.html">Easy::Entity</a></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  {</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">explicit</span> <a class="code" href="classMastodon_1_1Easy_1_1PushSubscription.html#a7041c5e5c1f93f315a0c82ca88d97ca9">PushSubscription</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &json);</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <a class="code" href="classMastodon_1_1Easy_1_1PushSubscription.html#a7041c5e5c1f93f315a0c82ca88d97ca9">PushSubscription</a>();</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keyword">const</span> uint_fast64_t <a class="code" href="classMastodon_1_1Easy_1_1PushSubscription.html#aa2ce48deb2672a38516215641ab7a556">id</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">const</span> <span class="keywordtype">string</span> <a class="code" href="classMastodon_1_1Easy_1_1PushSubscription.html#ac99a87bcc2a21f8c54d3153785459ea6">endpoint</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keyword">const</span> <span class="keywordtype">string</span> <a class="code" href="classMastodon_1_1Easy_1_1PushSubscription.html#a3547d26e8d81907588863f27d5ea5cd6">server_key</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="comment">// TODO: Look up what the data looks like</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"></span> <span class="keyword">const</span> <a class="code" href="classMastodon_1_1Easy.html#a567b535e84bfcf423faa54b758c2931a">Easy::alertmap</a> <a class="code" href="classMastodon_1_1Easy_1_1PushSubscription.html#a520c4fdf6c924c92ce4fa047b8e04ead">alerts</a>() <span class="keyword">const</span>;</div><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>  <span class="keyword">protected</span>:</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keyword">const</span> <span class="keywordtype">bool</span> <a class="code" href="classMastodon_1_1Easy_1_1PushSubscription.html#a901cfe18a22fbb2bbc8cbf9bf3892ec8">s_to_b</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &str) <span class="keyword">const</span>;</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> };</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> }</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="preprocessor">#endif // MASTODON_CPP_EASY_PUSHSUBSCRIPTION_HPP</span></div><div class="ttc" id="classMastodon_1_1Easy_1_1PushSubscription_html_aa2ce48deb2672a38516215641ab7a556"><div class="ttname"><a href="classMastodon_1_1Easy_1_1PushSubscription.html#aa2ce48deb2672a38516215641ab7a556">Mastodon::Easy::PushSubscription::id</a></div><div class="ttdeci">const uint_fast64_t id() const</div><div class="ttdoc">Returns push subscription ID. </div><div class="ttdef"><b>Definition:</b> pushsubscription.cpp:26</div></div>
|
|
<div class="ttc" id="classMastodon_1_1Easy_1_1PushSubscription_html_a3547d26e8d81907588863f27d5ea5cd6"><div class="ttname"><a href="classMastodon_1_1Easy_1_1PushSubscription.html#a3547d26e8d81907588863f27d5ea5cd6">Mastodon::Easy::PushSubscription::server_key</a></div><div class="ttdeci">const string server_key() const</div><div class="ttdoc">Returns the server public key for signature verification. </div><div class="ttdef"><b>Definition:</b> pushsubscription.cpp:40</div></div>
|
|
<div class="ttc" id="classMastodon_1_1Easy_1_1PushSubscription_html_a901cfe18a22fbb2bbc8cbf9bf3892ec8"><div class="ttname"><a href="classMastodon_1_1Easy_1_1PushSubscription.html#a901cfe18a22fbb2bbc8cbf9bf3892ec8">Mastodon::Easy::PushSubscription::s_to_b</a></div><div class="ttdeci">const bool s_to_b(const string &str) const</div><div class="ttdoc">Converts string to bool. </div><div class="ttdef"><b>Definition:</b> pushsubscription.cpp:79</div></div>
|
|
<div class="ttc" id="classMastodon_1_1Easy_1_1PushSubscription_html"><div class="ttname"><a href="classMastodon_1_1Easy_1_1PushSubscription.html">Mastodon::Easy::PushSubscription</a></div><div class="ttdoc">Class to hold push subscriptions. </div><div class="ttdef"><b>Definition:</b> pushsubscription.hpp:43</div></div>
|
|
<div class="ttc" id="classMastodon_1_1Easy_1_1PushSubscription_html_a7041c5e5c1f93f315a0c82ca88d97ca9"><div class="ttname"><a href="classMastodon_1_1Easy_1_1PushSubscription.html#a7041c5e5c1f93f315a0c82ca88d97ca9">Mastodon::Easy::PushSubscription::PushSubscription</a></div><div class="ttdeci">PushSubscription()</div><div class="ttdoc">Constructs an empty PushSubscription object. </div><div class="ttdef"><b>Definition:</b> pushsubscription.cpp:31</div></div>
|
|
<div class="ttc" id="classMastodon_1_1Easy_html_a567b535e84bfcf423faa54b758c2931a"><div class="ttname"><a href="classMastodon_1_1Easy.html#a567b535e84bfcf423faa54b758c2931a">Mastodon::Easy::alertmap</a></div><div class="ttdeci">std::map< Easy::notification_type, bool > alertmap</div><div class="ttdoc">Map of &#39;notification type&#39; and &#39;push is requested or not&#39;. </div><div class="ttdef"><b>Definition:</b> easy.hpp:133</div></div>
|
|
<div class="ttc" id="namespaceMastodon_html"><div class="ttname"><a href="namespaceMastodon.html">Mastodon</a></div><div class="ttdef"><b>Definition:</b> mastodon-cpp.hpp:52</div></div>
|
|
<div class="ttc" id="classMastodon_1_1Easy_1_1Entity_html"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Entity.html">Mastodon::Easy::Entity</a></div><div class="ttdoc">Base class for all entities. </div><div class="ttdef"><b>Definition:</b> easy.hpp:297</div></div>
|
|
<div class="ttc" id="classMastodon_1_1Easy_1_1PushSubscription_html_a520c4fdf6c924c92ce4fa047b8e04ead"><div class="ttname"><a href="classMastodon_1_1Easy_1_1PushSubscription.html#a520c4fdf6c924c92ce4fa047b8e04ead">Mastodon::Easy::PushSubscription::alerts</a></div><div class="ttdeci">const Easy::alertmap alerts() const</div><div class="ttdoc">Returns a map of &#39;notification event type&#39; and &#39;push is requested or not&#39;. </div><div class="ttdef"><b>Definition:</b> pushsubscription.cpp:45</div></div>
|
|
<div class="ttc" id="classMastodon_1_1Easy_1_1PushSubscription_html_ac99a87bcc2a21f8c54d3153785459ea6"><div class="ttname"><a href="classMastodon_1_1Easy_1_1PushSubscription.html#ac99a87bcc2a21f8c54d3153785459ea6">Mastodon::Easy::PushSubscription::endpoint</a></div><div class="ttdeci">const string endpoint() const</div><div class="ttdoc">Returns the endpoint URL. </div><div class="ttdef"><b>Definition:</b> pushsubscription.cpp:35</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.14
|
|
</small></address>
|
|
</body>
|
|
</html>
|