diff options
Diffstat (limited to 'docs/class_tg_bot_1_1_bot.html')
| -rw-r--r-- | docs/class_tg_bot_1_1_bot.html | 266 |
1 files changed, 266 insertions, 0 deletions
diff --git a/docs/class_tg_bot_1_1_bot.html b/docs/class_tg_bot_1_1_bot.html new file mode 100644 index 0000000..e0ef726 --- /dev/null +++ b/docs/class_tg_bot_1_1_bot.html @@ -0,0 +1,266 @@ +<!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.13"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>tgbot-cpp: TgBot::Bot 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="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtreedata.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); +</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">tgbot-cpp + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.13 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +</script> +<div id="main-nav"></div> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('class_tg_bot_1_1_bot.html','');}); +</script> +<div id="doc-content"> +<!-- 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 class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="class_tg_bot_1_1_bot-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">TgBot::Bot Class Reference<div class="ingroups"><a class="el" href="group__general.html">General</a></div></div> </div> +</div><!--header--> +<div class="contents"> + +<p><code>#include <<a class="el" href="_bot_8h_source.html">Bot.h</a>></code></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:a8b644ad116aa6f79a7bc2c308e02d332"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_bot.html#a8b644ad116aa6f79a7bc2c308e02d332">Bot</a> (const std::string &token)</td></tr> +<tr class="separator:a8b644ad116aa6f79a7bc2c308e02d332"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6443b4ec5838112a4f5689ec60665e91"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_bot.html#a6443b4ec5838112a4f5689ec60665e91">getToken</a> () const</td></tr> +<tr class="separator:a6443b4ec5838112a4f5689ec60665e91"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a99a820c47aa8f8cc0dba35bcd001cbe3"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="class_tg_bot_1_1_api.html">Api</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_bot.html#a99a820c47aa8f8cc0dba35bcd001cbe3">getApi</a> () const</td></tr> +<tr class="separator:a99a820c47aa8f8cc0dba35bcd001cbe3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac7becb36b294dfbc556d534925d564ac"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_tg_bot_1_1_event_broadcaster.html">EventBroadcaster</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_bot.html#ac7becb36b294dfbc556d534925d564ac">getEvents</a> ()</td></tr> +<tr class="separator:ac7becb36b294dfbc556d534925d564ac"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2f36a7774c1552d00c6e08accf495579"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="class_tg_bot_1_1_event_handler.html">EventHandler</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_bot.html#a2f36a7774c1552d00c6e08accf495579">getEventHandler</a> () const</td></tr> +<tr class="separator:a2f36a7774c1552d00c6e08accf495579"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>This object holds other objects specific for this bot instance. </p> + +<p class="definition">Definition at line <a class="el" href="_bot_8h_source.html#l00038">38</a> of file <a class="el" href="_bot_8h_source.html">Bot.h</a>.</p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="a8b644ad116aa6f79a7bc2c308e02d332"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a8b644ad116aa6f79a7bc2c308e02d332">◆ </a></span>Bot()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">TgBot::Bot::Bot </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>token</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_bot_8h_source.html#l00041">41</a> of file <a class="el" href="_bot_8h_source.html">Bot.h</a>.</p> + +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="a99a820c47aa8f8cc0dba35bcd001cbe3"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a99a820c47aa8f8cc0dba35bcd001cbe3">◆ </a></span>getApi()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">const <a class="el" href="class_tg_bot_1_1_api.html">Api</a>& TgBot::Bot::getApi </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<dl class="section return"><dt>Returns</dt><dd>Object which can execute Telegram <a class="el" href="class_tg_bot_1_1_bot.html">Bot</a> API methods. </dd></dl> + +<p class="definition">Definition at line <a class="el" href="_bot_8h_source.html#l00054">54</a> of file <a class="el" href="_bot_8h_source.html">Bot.h</a>.</p> + +</div> +</div> +<a id="a2f36a7774c1552d00c6e08accf495579"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a2f36a7774c1552d00c6e08accf495579">◆ </a></span>getEventHandler()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">const <a class="el" href="class_tg_bot_1_1_event_handler.html">EventHandler</a>& TgBot::Bot::getEventHandler </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<dl class="section return"><dt>Returns</dt><dd>Object which handles new update objects. Usually it's only needed for <a class="el" href="class_tg_bot_1_1_tg_long_poll.html">TgLongPoll</a>, TgWebhookLocalServer and <a class="el" href="class_tg_bot_1_1_tg_webhook_tcp_server.html">TgWebhookTcpServer</a> objects. </dd></dl> + +<p class="definition">Definition at line <a class="el" href="_bot_8h_source.html#l00068">68</a> of file <a class="el" href="_bot_8h_source.html">Bot.h</a>.</p> + +</div> +</div> +<a id="ac7becb36b294dfbc556d534925d564ac"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ac7becb36b294dfbc556d534925d564ac">◆ </a></span>getEvents()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_tg_bot_1_1_event_broadcaster.html">EventBroadcaster</a>& TgBot::Bot::getEvents </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<dl class="section return"><dt>Returns</dt><dd>Object which holds all event listeners. </dd></dl> + +<p class="definition">Definition at line <a class="el" href="_bot_8h_source.html#l00061">61</a> of file <a class="el" href="_bot_8h_source.html">Bot.h</a>.</p> + +</div> +</div> +<a id="a6443b4ec5838112a4f5689ec60665e91"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a6443b4ec5838112a4f5689ec60665e91">◆ </a></span>getToken()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">const std::string& TgBot::Bot::getToken </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<dl class="section return"><dt>Returns</dt><dd>Token for accessing api. </dd></dl> + +<p class="definition">Definition at line <a class="el" href="_bot_8h_source.html#l00047">47</a> of file <a class="el" href="_bot_8h_source.html">Bot.h</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>include/tgbot/<a class="el" href="_bot_8h_source.html">Bot.h</a></li> +</ul> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="navelem"><a class="el" href="namespace_tg_bot.html">TgBot</a></li><li class="navelem"><a class="el" href="class_tg_bot_1_1_bot.html">Bot</a></li> + <li class="footer">Generated on Sun Jan 15 2017 02:46:16 for tgbot-cpp by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> + </ul> +</div> +</body> +</html> |