hauke/LibTgBotPP
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Docu

Browse Source
This commit is contained in:
Hauke Zühl
2016-05-02 14:20:18 +02:00
parent cdf5271db0
commit a95ada30db
189 changed files with 7284 additions and 675 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/html/classTelegram_1_1TelegramBot.html
+73 -5
View File
@@ -157,7 +157,10 @@ Private Attributes</h2></td></tr>
<tr class="memitem:a33ce0cbad266e831c834aa2e3d854e5a"><td class="memItemLeft" align="right" valign="top">Json::Int64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelegram_1_1TelegramBot.html#a33ce0cbad266e831c834aa2e3d854e5a">chat_id</a></td></tr>
<tr class="separator:a33ce0cbad266e831c834aa2e3d854e5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p>Definition at line <a class="el" href="TelegramBot_8h_source.html#l00026">26</a> of file <a class="el" href="TelegramBot_8h_source.html">TelegramBot.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a99b561e695953e6b69a3ddf6937a4811"></a>
<div class="memitem">
<div class="memproto">
@@ -170,6 +173,9 @@ Private Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor of Bot </p>
<p>Definition at line <a class="el" href="TelegramBot_8cc_source.html#l00022">22</a> of file <a class="el" href="TelegramBot_8cc_source.html">TelegramBot.cc</a>.</p>
</div>
</div>
@@ -186,6 +192,15 @@ Private Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor of bot</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">token</td><td>a std::string </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="TelegramBot_8cc_source.html#l00033">33</a> of file <a class="el" href="TelegramBot_8cc_source.html">TelegramBot.cc</a>.</p>
</div>
</div>
@@ -203,6 +218,15 @@ Private Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Adds a callback to the command list of the bot</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cmd</td><td>a structure of type <a class="el" href="structTelegram_1_1TCommand.html">TCommand</a> </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="TelegramBot_8cc_source.html#l00044">44</a> of file <a class="el" href="TelegramBot_8cc_source.html">TelegramBot.cc</a>.</p>
</div>
</div>
@@ -237,6 +261,9 @@ Private Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>A generic API request </p>
<p>Definition at line <a class="el" href="TelegramBot_8cc_source.html#l00123">123</a> of file <a class="el" href="TelegramBot_8cc_source.html">TelegramBot.cc</a>.</p>
</div>
</div>
@@ -271,6 +298,9 @@ Private Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>An API request, posting JSON data </p>
<p>Definition at line <a class="el" href="TelegramBot_8cc_source.html#l00160">160</a> of file <a class="el" href="TelegramBot_8cc_source.html">TelegramBot.cc</a>.</p>
</div>
</div>
@@ -287,6 +317,8 @@ Private Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="TelegramBot_8cc_source.html#l00109">109</a> of file <a class="el" href="TelegramBot_8cc_source.html">TelegramBot.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a7c54766f656974b35f03ea510d7b6a4f"></a>
@@ -302,6 +334,8 @@ Private Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="TelegramBot_8cc_source.html#l00104">104</a> of file <a class="el" href="TelegramBot_8cc_source.html">TelegramBot.cc</a>.</p>
</div>
</div>
<a class="anchor" id="ae0d0fe5d54afcc9e6ee16b3d4f8ae895"></a>
@@ -326,6 +360,8 @@ Private Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="TelegramBot_8cc_source.html#l00115">115</a> of file <a class="el" href="TelegramBot_8cc_source.html">TelegramBot.cc</a>.</p>
</div>
</div>
<a class="anchor" id="aed4dd1ce506259c0e82f0c46fe125ca4"></a>
@@ -350,6 +386,8 @@ Private Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="TelegramBot_8cc_source.html#l00187">187</a> of file <a class="el" href="TelegramBot_8cc_source.html">TelegramBot.cc</a>.</p>
</div>
</div>
<a class="anchor" id="af6fbb842f679b33dd8a60f94f82d7c81"></a>
@@ -365,6 +403,15 @@ Private Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Process incoming message</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">message</td><td>a std::string storing the message sent by the <a class="el" href="namespaceTelegram.html">Telegram</a> system </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="TelegramBot_8cc_source.html#l00074">74</a> of file <a class="el" href="TelegramBot_8cc_source.html">TelegramBot.cc</a>.</p>
</div>
</div>
@@ -391,6 +438,9 @@ Private Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Send a text message to a user </p>
<p>Definition at line <a class="el" href="TelegramBot_8cc_source.html#l00090">90</a> of file <a class="el" href="TelegramBot_8cc_source.html">TelegramBot.cc</a>.</p>
</div>
</div>
@@ -418,6 +468,8 @@ Private Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="TelegramBot_8cc_source.html#l00095">95</a> of file <a class="el" href="TelegramBot_8cc_source.html">TelegramBot.cc</a>.</p>
</div>
</div>
<a class="anchor" id="aabd1a825b1d7f127f15bf336b985d70d"></a>
@@ -433,7 +485,15 @@ Private Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Set the webhook The web hook URL is like <a href="https://">https://</a>&lt;your domain&gt;=""&gt;/cgi-bin/mybot.cgi A web hook must be set before you can get any messages from the <a class="el" href="namespaceTelegram.html">Telegram</a> network! </p>
<p>Set the webhook The web hook URL is like <a href="https://">https://</a>&lt;your domain&gt;=""&gt;/cgi-bin/mybot.cgi A web hook must be set before you can get any messages from the <a class="el" href="namespaceTelegram.html">Telegram</a> network!</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">url</td><td>a std::string with the URL of the hook </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="TelegramBot_8cc_source.html#l00060">60</a> of file <a class="el" href="TelegramBot_8cc_source.html">TelegramBot.cc</a>.</p>
</div>
</div>
@@ -456,6 +516,8 @@ Private Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="TelegramBot_8h_source.html#l00051">51</a> of file <a class="el" href="TelegramBot_8h_source.html">TelegramBot.h</a>.</p>
</div>
</div>
<a class="anchor" id="a33ce0cbad266e831c834aa2e3d854e5a"></a>
@@ -476,6 +538,8 @@ Private Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="TelegramBot_8h_source.html#l00054">54</a> of file <a class="el" href="TelegramBot_8h_source.html">TelegramBot.h</a>.</p>
</div>
</div>
<a class="anchor" id="a4729f977e1d564326f0061c1417dc09c"></a>
@@ -496,6 +560,8 @@ Private Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="TelegramBot_8h_source.html#l00053">53</a> of file <a class="el" href="TelegramBot_8h_source.html">TelegramBot.h</a>.</p>
</div>
</div>
<a class="anchor" id="a27ee4520baa0cf7f36ec6f13e69867a5"></a>
@@ -516,11 +582,13 @@ Private Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="TelegramBot_8h_source.html#l00052">52</a> of file <a class="el" href="TelegramBot_8h_source.html">TelegramBot.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>include/Telegram/<a class="el" href="TelegramBot_8h_source.html">TelegramBot.h</a></li>
<li>src/<a class="el" href="TelegramBot_8cc.html">TelegramBot.cc</a></li>
<li><a class="el" href="TelegramBot_8h_source.html">TelegramBot.h</a></li>
<li><a class="el" href="TelegramBot_8cc_source.html">TelegramBot.cc</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
@@ -528,7 +596,7 @@ Private Attributes</h2></td></tr>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespaceTelegram.html">Telegram</a></li><li class="navelem"><a class="el" href="classTelegram_1_1TelegramBot.html">TelegramBot</a></li>
<li class="footer">Generated on Mon May 2 2016 10:12:40 for LibTgBotPP by
<li class="footer">Generated on Mon May 2 2016 14:19:24 for LibTgBotPP by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
</ul>