diff options
Diffstat (limited to 'docs/class_tg_bot_1_1_update.html')
| -rw-r--r-- | docs/class_tg_bot_1_1_update.html | 290 |
1 files changed, 290 insertions, 0 deletions
diff --git a/docs/class_tg_bot_1_1_update.html b/docs/class_tg_bot_1_1_update.html new file mode 100644 index 0000000..857519e --- /dev/null +++ b/docs/class_tg_bot_1_1_update.html @@ -0,0 +1,290 @@ +<!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::Update 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_update.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-types">Public Types</a> | +<a href="#pub-attribs">Public Attributes</a> | +<a href="class_tg_bot_1_1_update-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">TgBot::Update Class Reference<div class="ingroups"><a class="el" href="group__types.html">Types</a></div></div> </div> +</div><!--header--> +<div class="contents"> + +<p><code>#include <<a class="el" href="_update_8h_source.html">Update.h</a>></code></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> +Public Types</h2></td></tr> +<tr class="memitem:abace63cf3605fe7a480a3bb839a672a8"><td class="memItemLeft" align="right" valign="top">typedef std::shared_ptr< <a class="el" href="class_tg_bot_1_1_update.html">Update</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_update.html#abace63cf3605fe7a480a3bb839a672a8">Ptr</a></td></tr> +<tr class="separator:abace63cf3605fe7a480a3bb839a672a8"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> +Public Attributes</h2></td></tr> +<tr class="memitem:af4d35314c4e49839f7012a9671ede097"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_update.html#af4d35314c4e49839f7012a9671ede097">updateId</a></td></tr> +<tr class="separator:af4d35314c4e49839f7012a9671ede097"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab65136c0345978742fb3026e6855ff2c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_update.html#ab65136c0345978742fb3026e6855ff2c">message</a></td></tr> +<tr class="separator:ab65136c0345978742fb3026e6855ff2c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a188502d94515baee85ba30f58cffa1b5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_update.html#a188502d94515baee85ba30f58cffa1b5">editedMessage</a></td></tr> +<tr class="separator:a188502d94515baee85ba30f58cffa1b5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aabddc6947fe255f1763802532d34ef2b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_update.html#aabddc6947fe255f1763802532d34ef2b">channelPost</a></td></tr> +<tr class="separator:aabddc6947fe255f1763802532d34ef2b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a05588da55717387ef91434f014afff1b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_update.html#a05588da55717387ef91434f014afff1b">editedChannelPost</a></td></tr> +<tr class="separator:a05588da55717387ef91434f014afff1b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aea03e36b9015a0fe9f1278564c5b8806"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_tg_bot_1_1_inline_query.html#a82b36b38b3587e6a721b6fa579759b0c">InlineQuery::Ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_update.html#aea03e36b9015a0fe9f1278564c5b8806">inlineQuery</a></td></tr> +<tr class="separator:aea03e36b9015a0fe9f1278564c5b8806"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa3fab72bc10111e2f8f8930c43a0ff8b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_tg_bot_1_1_chosen_inline_result.html#ad4b7edd30fd0d876fa99493fe19b3247">ChosenInlineResult::Ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_update.html#aa3fab72bc10111e2f8f8930c43a0ff8b">chosenInlineResult</a></td></tr> +<tr class="separator:aa3fab72bc10111e2f8f8930c43a0ff8b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2c6890adcab16d6a306b3b89fd954f6f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_tg_bot_1_1_callback_query.html#a5a5e4f8368bd95ba214e68cde5d1c7c0">CallbackQuery::Ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_update.html#a2c6890adcab16d6a306b3b89fd954f6f">callbackQuery</a></td></tr> +<tr class="separator:a2c6890adcab16d6a306b3b89fd954f6f"><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 represents an incoming update. </p> + +<p class="definition">Definition at line <a class="el" href="_update_8h_source.html#l00039">39</a> of file <a class="el" href="_update_8h_source.html">Update.h</a>.</p> +</div><h2 class="groupheader">Member Typedef Documentation</h2> +<a id="abace63cf3605fe7a480a3bb839a672a8"></a> +<h2 class="memtitle"><span class="permalink"><a href="#abace63cf3605fe7a480a3bb839a672a8">◆ </a></span>Ptr</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef std::shared_ptr<<a class="el" href="class_tg_bot_1_1_update.html">Update</a>> <a class="el" href="class_tg_bot_1_1_update.html#abace63cf3605fe7a480a3bb839a672a8">TgBot::Update::Ptr</a></td> + </tr> + </table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_update_8h_source.html#l00042">42</a> of file <a class="el" href="_update_8h_source.html">Update.h</a>.</p> + +</div> +</div> +<h2 class="groupheader">Member Data Documentation</h2> +<a id="a2c6890adcab16d6a306b3b89fd954f6f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a2c6890adcab16d6a306b3b89fd954f6f">◆ </a></span>callbackQuery</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_tg_bot_1_1_callback_query.html#a5a5e4f8368bd95ba214e68cde5d1c7c0">CallbackQuery::Ptr</a> TgBot::Update::callbackQuery</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Optional. New incoming callback query. </p> + +<p class="definition">Definition at line <a class="el" href="_update_8h_source.html#l00082">82</a> of file <a class="el" href="_update_8h_source.html">Update.h</a>.</p> + +</div> +</div> +<a id="aabddc6947fe255f1763802532d34ef2b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aabddc6947fe255f1763802532d34ef2b">◆ </a></span>channelPost</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> TgBot::Update::channelPost</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Optional. New incoming channel post of any kind — text, photo, sticker, etc. </p> + +<p class="definition">Definition at line <a class="el" href="_update_8h_source.html#l00062">62</a> of file <a class="el" href="_update_8h_source.html">Update.h</a>.</p> + +</div> +</div> +<a id="aa3fab72bc10111e2f8f8930c43a0ff8b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aa3fab72bc10111e2f8f8930c43a0ff8b">◆ </a></span>chosenInlineResult</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_tg_bot_1_1_chosen_inline_result.html#ad4b7edd30fd0d876fa99493fe19b3247">ChosenInlineResult::Ptr</a> TgBot::Update::chosenInlineResult</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Optional. The result of an inline query that was chosen by a user and sent to their chat partner. </p> + +<p class="definition">Definition at line <a class="el" href="_update_8h_source.html#l00077">77</a> of file <a class="el" href="_update_8h_source.html">Update.h</a>.</p> + +</div> +</div> +<a id="a05588da55717387ef91434f014afff1b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a05588da55717387ef91434f014afff1b">◆ </a></span>editedChannelPost</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> TgBot::Update::editedChannelPost</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Optional. New version of a channel post that is known to the bot and was edited </p> + +<p class="definition">Definition at line <a class="el" href="_update_8h_source.html#l00067">67</a> of file <a class="el" href="_update_8h_source.html">Update.h</a>.</p> + +</div> +</div> +<a id="a188502d94515baee85ba30f58cffa1b5"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a188502d94515baee85ba30f58cffa1b5">◆ </a></span>editedMessage</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> TgBot::Update::editedMessage</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Optional. New version of a message that is known to the bot and was edited </p> + +<p class="definition">Definition at line <a class="el" href="_update_8h_source.html#l00057">57</a> of file <a class="el" href="_update_8h_source.html">Update.h</a>.</p> + +</div> +</div> +<a id="aea03e36b9015a0fe9f1278564c5b8806"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aea03e36b9015a0fe9f1278564c5b8806">◆ </a></span>inlineQuery</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_tg_bot_1_1_inline_query.html#a82b36b38b3587e6a721b6fa579759b0c">InlineQuery::Ptr</a> TgBot::Update::inlineQuery</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Optional. New incoming inline query </p> + +<p class="definition">Definition at line <a class="el" href="_update_8h_source.html#l00072">72</a> of file <a class="el" href="_update_8h_source.html">Update.h</a>.</p> + +</div> +</div> +<a id="ab65136c0345978742fb3026e6855ff2c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ab65136c0345978742fb3026e6855ff2c">◆ </a></span>message</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_tg_bot_1_1_message.html#a3805a5dc013c6ab23ac5efc91282c11d">Message::Ptr</a> TgBot::Update::message</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Optional. New incoming message of any kind — text, photo, sticker, etc. </p> + +<p class="definition">Definition at line <a class="el" href="_update_8h_source.html#l00052">52</a> of file <a class="el" href="_update_8h_source.html">Update.h</a>.</p> + +</div> +</div> +<a id="af4d35314c4e49839f7012a9671ede097"></a> +<h2 class="memtitle"><span class="permalink"><a href="#af4d35314c4e49839f7012a9671ede097">◆ </a></span>updateId</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int32_t TgBot::Update::updateId</td> + </tr> + </table> +</div><div class="memdoc"> +<p>The update‘s unique identifier. <a class="el" href="class_tg_bot_1_1_update.html">Update</a> identifiers start from a certain positive number and increase sequentially. This ID becomes especially handy if you’re using Webhooks, since it allows you to ignore repeated updates or to restore the correct update sequence, should they get out of order. </p> + +<p class="definition">Definition at line <a class="el" href="_update_8h_source.html#l00047">47</a> of file <a class="el" href="_update_8h_source.html">Update.h</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>include/tgbot/types/<a class="el" href="_update_8h_source.html">Update.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_update.html">Update</a></li> + <li class="footer">Generated on Sun Jan 15 2017 02:46:17 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> |