docs updated

This commit is contained in:
Hauke Zühl
2017-06-06 14:39:53 +02:00
parent 23370963d4
commit d75e40bea7
143 changed files with 690 additions and 474 deletions
+56 -36
View File
@@ -126,14 +126,16 @@ Public Member Functions</h2></td></tr>
<tr class="separator:aabd1a825b1d7f127f15bf336b985d70d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af6fbb842f679b33dd8a60f94f82d7c81"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelegram_1_1TelegramBot.html#af6fbb842f679b33dd8a60f94f82d7c81">processMessage</a> (std::string)</td></tr>
<tr class="separator:af6fbb842f679b33dd8a60f94f82d7c81"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1645dae5fdfb1437bb8976f44c237563"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelegram_1_1TelegramBot.html#a1645dae5fdfb1437bb8976f44c237563">sendMessage</a> (std::string, Json::Int64)</td></tr>
<tr class="separator:a1645dae5fdfb1437bb8976f44c237563"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac9fdf927b0ebf72b40a0a75639e39d18"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelegram_1_1TelegramBot.html#ac9fdf927b0ebf72b40a0a75639e39d18">sendMessage</a> (std::string, std::string)</td></tr>
<tr class="separator:ac9fdf927b0ebf72b40a0a75639e39d18"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58e633cc42dcd964a37e2814102764bc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelegram_1_1TelegramBot.html#a58e633cc42dcd964a37e2814102764bc">sendPhoto</a> (std::string, Json::Int64)</td></tr>
<tr class="separator:a58e633cc42dcd964a37e2814102764bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a257660b7cead3d886d94824efe9819f6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelegram_1_1TelegramBot.html#a257660b7cead3d886d94824efe9819f6">sendPhoto</a> (std::string, std::string)</td></tr>
<tr class="separator:a257660b7cead3d886d94824efe9819f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a18326a958f926cdea62339899a29a1e1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classTelegram_1_1User.html">Telegram::User</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelegram_1_1TelegramBot.html#a18326a958f926cdea62339899a29a1e1">getMe</a> (void)</td></tr>
<tr class="separator:a18326a958f926cdea62339899a29a1e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd21ba91f309c6d5fbcf7dc0063375ae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classTelegram_1_1Message.html">Telegram::Message</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelegram_1_1TelegramBot.html#acd21ba91f309c6d5fbcf7dc0063375ae">sendMessage</a> (std::string, Json::Int64)</td></tr>
<tr class="separator:acd21ba91f309c6d5fbcf7dc0063375ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a592741f23db9675eb5e6ae60f6ee926b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classTelegram_1_1Message.html">Telegram::Message</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelegram_1_1TelegramBot.html#a592741f23db9675eb5e6ae60f6ee926b">sendMessage</a> (std::string, std::string)</td></tr>
<tr class="separator:a592741f23db9675eb5e6ae60f6ee926b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adb9d623814ecbbeeefef4faa073b73c3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classTelegram_1_1Message.html">Telegram::Message</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelegram_1_1TelegramBot.html#adb9d623814ecbbeeefef4faa073b73c3">sendPhoto</a> (std::string, Json::Int64)</td></tr>
<tr class="separator:adb9d623814ecbbeeefef4faa073b73c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1f3a5159b2868b2aa7a84f3ca8f0104c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classTelegram_1_1Message.html">Telegram::Message</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelegram_1_1TelegramBot.html#a1f3a5159b2868b2aa7a84f3ca8f0104c">sendPhoto</a> (std::string, std::string)</td></tr>
<tr class="separator:a1f3a5159b2868b2aa7a84f3ca8f0104c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c54766f656974b35f03ea510d7b6a4f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classTelegram_1_1Message.html">Telegram::Message</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelegram_1_1TelegramBot.html#a7c54766f656974b35f03ea510d7b6a4f">getMessage</a> ()</td></tr>
<tr class="separator:a7c54766f656974b35f03ea510d7b6a4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae9aba06108ce34f9766199c6588e1d6"><td class="memItemLeft" align="right" valign="top">std::map&lt; std::string, <a class="el" href="structTelegram_1_1TCommand.html">TCommand</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelegram_1_1TelegramBot.html#aae9aba06108ce34f9766199c6588e1d6">getCommandMap</a> ()</td></tr>
@@ -145,8 +147,8 @@ Private Member Functions</h2></td></tr>
<tr class="separator:ae0d0fe5d54afcc9e6ee16b3d4f8ae895"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7e07f1ca99390958ef5c6c95cbf18258"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelegram_1_1TelegramBot.html#a7e07f1ca99390958ef5c6c95cbf18258">apiRequest</a> (std::string, std::map&lt; std::string, std::string &gt;)</td></tr>
<tr class="separator:a7e07f1ca99390958ef5c6c95cbf18258"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ee0c2d12f906cb2e0a9b7fb2d7e45a5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelegram_1_1TelegramBot.html#a9ee0c2d12f906cb2e0a9b7fb2d7e45a5">apiRequestJson</a> (std::string, std::map&lt; std::string, std::string &gt;)</td></tr>
<tr class="separator:a9ee0c2d12f906cb2e0a9b7fb2d7e45a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aba249898870b8250da0ac67ba6a55e88"><td class="memItemLeft" align="right" valign="top">Json::Value&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelegram_1_1TelegramBot.html#aba249898870b8250da0ac67ba6a55e88">apiRequestJson</a> (std::string, std::map&lt; std::string, std::string &gt;)</td></tr>
<tr class="separator:aba249898870b8250da0ac67ba6a55e88"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed4dd1ce506259c0e82f0c46fe125ca4"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelegram_1_1TelegramBot.html#aed4dd1ce506259c0e82f0c46fe125ca4">processCommand</a> (std::string)</td></tr>
<tr class="separator:aed4dd1ce506259c0e82f0c46fe125ca4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
@@ -163,7 +165,7 @@ Private Attributes</h2></td></tr>
</table>
<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#l00032">32</a> of file <a class="el" href="TelegramBot_8h_source.html">TelegramBot.h</a>.</p>
<p>Definition at line <a class="el" href="TelegramBot_8h_source.html#l00033">33</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">
@@ -267,11 +269,11 @@ Private Attributes</h2></td></tr>
</div><div class="memdoc">
<p>A generic API request </p>
<p>Definition at line <a class="el" href="TelegramBot_8cc_source.html#l00147">147</a> of file <a class="el" href="TelegramBot_8cc_source.html">TelegramBot.cc</a>.</p>
<p>Definition at line <a class="el" href="TelegramBot_8cc_source.html#l00165">165</a> of file <a class="el" href="TelegramBot_8cc_source.html">TelegramBot.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a9ee0c2d12f906cb2e0a9b7fb2d7e45a5"></a>
<a class="anchor" id="aba249898870b8250da0ac67ba6a55e88"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
@@ -279,7 +281,7 @@ Private Attributes</h2></td></tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Telegram::TelegramBot::apiRequestJson </td>
<td class="memname">Json::Value Telegram::TelegramBot::apiRequestJson </td>
<td>(</td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>method</em>, </td>
@@ -304,7 +306,7 @@ Private Attributes</h2></td></tr>
</div><div class="memdoc">
<p>An API request, posting JSON data </p>
<p>Definition at line <a class="el" href="TelegramBot_8cc_source.html#l00184">184</a> of file <a class="el" href="TelegramBot_8cc_source.html">TelegramBot.cc</a>.</p>
<p>Definition at line <a class="el" href="TelegramBot_8cc_source.html#l00202">202</a> of file <a class="el" href="TelegramBot_8cc_source.html">TelegramBot.cc</a>.</p>
</div>
</div>
@@ -321,7 +323,25 @@ Private Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="TelegramBot_8cc_source.html#l00133">133</a> of file <a class="el" href="TelegramBot_8cc_source.html">TelegramBot.cc</a>.</p>
<p>Definition at line <a class="el" href="TelegramBot_8cc_source.html#l00151">151</a> of file <a class="el" href="TelegramBot_8cc_source.html">TelegramBot.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a18326a958f926cdea62339899a29a1e1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelegram_1_1User.html">Telegram::User</a> * Telegram::TelegramBot::getMe </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="TelegramBot_8cc_source.html#l00087">87</a> of file <a class="el" href="TelegramBot_8cc_source.html">TelegramBot.cc</a>.</p>
</div>
</div>
@@ -338,7 +358,7 @@ Private Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="TelegramBot_8cc_source.html#l00128">128</a> of file <a class="el" href="TelegramBot_8cc_source.html">TelegramBot.cc</a>.</p>
<p>Definition at line <a class="el" href="TelegramBot_8cc_source.html#l00146">146</a> of file <a class="el" href="TelegramBot_8cc_source.html">TelegramBot.cc</a>.</p>
</div>
</div>
@@ -364,7 +384,7 @@ Private Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="TelegramBot_8cc_source.html#l00139">139</a> of file <a class="el" href="TelegramBot_8cc_source.html">TelegramBot.cc</a>.</p>
<p>Definition at line <a class="el" href="TelegramBot_8cc_source.html#l00157">157</a> of file <a class="el" href="TelegramBot_8cc_source.html">TelegramBot.cc</a>.</p>
</div>
</div>
@@ -390,7 +410,7 @@ Private Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="TelegramBot_8cc_source.html#l00211">211</a> of file <a class="el" href="TelegramBot_8cc_source.html">TelegramBot.cc</a>.</p>
<p>Definition at line <a class="el" href="TelegramBot_8cc_source.html#l00238">238</a> of file <a class="el" href="TelegramBot_8cc_source.html">TelegramBot.cc</a>.</p>
</div>
</div>
@@ -419,12 +439,12 @@ Private Attributes</h2></td></tr>
</div>
</div>
<a class="anchor" id="a1645dae5fdfb1437bb8976f44c237563"></a>
<a class="anchor" id="acd21ba91f309c6d5fbcf7dc0063375ae"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Telegram::TelegramBot::sendMessage </td>
<td class="memname"><a class="el" href="classTelegram_1_1Message.html">Telegram::Message</a> * Telegram::TelegramBot::sendMessage </td>
<td>(</td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>message</em>, </td>
@@ -444,16 +464,16 @@ Private Attributes</h2></td></tr>
</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>
<p>Definition at line <a class="el" href="TelegramBot_8cc_source.html#l00100">100</a> of file <a class="el" href="TelegramBot_8cc_source.html">TelegramBot.cc</a>.</p>
</div>
</div>
<a class="anchor" id="ac9fdf927b0ebf72b40a0a75639e39d18"></a>
<a class="anchor" id="a592741f23db9675eb5e6ae60f6ee926b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Telegram::TelegramBot::sendMessage </td>
<td class="memname"><a class="el" href="classTelegram_1_1Message.html">Telegram::Message</a> * Telegram::TelegramBot::sendMessage </td>
<td>(</td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>message</em>, </td>
@@ -473,16 +493,16 @@ Private Attributes</h2></td></tr>
</div><div class="memdoc">
<p>sendMessage sends a simple text message to a given chat (might be a user or a group) </p>
<p>Definition at line <a class="el" href="TelegramBot_8cc_source.html#l00098">98</a> of file <a class="el" href="TelegramBot_8cc_source.html">TelegramBot.cc</a>.</p>
<p>Definition at line <a class="el" href="TelegramBot_8cc_source.html#l00108">108</a> of file <a class="el" href="TelegramBot_8cc_source.html">TelegramBot.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a58e633cc42dcd964a37e2814102764bc"></a>
<a class="anchor" id="adb9d623814ecbbeeefef4faa073b73c3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Telegram::TelegramBot::sendPhoto </td>
<td class="memname"><a class="el" href="classTelegram_1_1Message.html">Telegram::Message</a> * Telegram::TelegramBot::sendPhoto </td>
<td>(</td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>URL</em>, </td>
@@ -502,16 +522,16 @@ Private Attributes</h2></td></tr>
</div><div class="memdoc">
<p>Sends a picture from the internet to a chat </p>
<p>Definition at line <a class="el" href="TelegramBot_8cc_source.html#l00110">110</a> of file <a class="el" href="TelegramBot_8cc_source.html">TelegramBot.cc</a>.</p>
<p>Definition at line <a class="el" href="TelegramBot_8cc_source.html#l00124">124</a> of file <a class="el" href="TelegramBot_8cc_source.html">TelegramBot.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a257660b7cead3d886d94824efe9819f6"></a>
<a class="anchor" id="a1f3a5159b2868b2aa7a84f3ca8f0104c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Telegram::TelegramBot::sendPhoto </td>
<td class="memname"><a class="el" href="classTelegram_1_1Message.html">Telegram::Message</a> * Telegram::TelegramBot::sendPhoto </td>
<td>(</td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>URL</em>, </td>
@@ -531,7 +551,7 @@ Private Attributes</h2></td></tr>
</div><div class="memdoc">
<p>Sends a picture from the internet to a chat </p>
<p>Definition at line <a class="el" href="TelegramBot_8cc_source.html#l00118">118</a> of file <a class="el" href="TelegramBot_8cc_source.html">TelegramBot.cc</a>.</p>
<p>Definition at line <a class="el" href="TelegramBot_8cc_source.html#l00132">132</a> of file <a class="el" href="TelegramBot_8cc_source.html">TelegramBot.cc</a>.</p>
</div>
</div>
@@ -579,7 +599,7 @@ 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>
<p>Definition at line <a class="el" href="TelegramBot_8h_source.html#l00055">55</a> of file <a class="el" href="TelegramBot_8h_source.html">TelegramBot.h</a>.</p>
</div>
</div>
@@ -601,7 +621,7 @@ 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>
<p>Definition at line <a class="el" href="TelegramBot_8h_source.html#l00058">58</a> of file <a class="el" href="TelegramBot_8h_source.html">TelegramBot.h</a>.</p>
</div>
</div>
@@ -623,7 +643,7 @@ 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>
<p>Definition at line <a class="el" href="TelegramBot_8h_source.html#l00057">57</a> of file <a class="el" href="TelegramBot_8h_source.html">TelegramBot.h</a>.</p>
</div>
</div>
@@ -645,7 +665,7 @@ 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>
<p>Definition at line <a class="el" href="TelegramBot_8h_source.html#l00056">56</a> of file <a class="el" href="TelegramBot_8h_source.html">TelegramBot.h</a>.</p>
</div>
</div>
@@ -659,7 +679,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 Sun Jun 4 2017 13:31:53 for LibTgBotPP by
<li class="footer">Generated on Tue Jun 6 2017 14:39:17 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>