diff options
Diffstat (limited to 'docs/class_tg_bot_1_1_webhook_info.html')
| -rw-r--r-- | docs/class_tg_bot_1_1_webhook_info.html | 271 |
1 files changed, 271 insertions, 0 deletions
diff --git a/docs/class_tg_bot_1_1_webhook_info.html b/docs/class_tg_bot_1_1_webhook_info.html new file mode 100644 index 0000000..a7ad3e2 --- /dev/null +++ b/docs/class_tg_bot_1_1_webhook_info.html @@ -0,0 +1,271 @@ +<!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::WebhookInfo 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_webhook_info.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_webhook_info-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">TgBot::WebhookInfo 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="_webhook_info_8h_source.html">WebhookInfo.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:a2280093713d1304207d8bba2204648d6"><td class="memItemLeft" align="right" valign="top">typedef std::shared_ptr< <a class="el" href="class_tg_bot_1_1_webhook_info.html">WebhookInfo</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_webhook_info.html#a2280093713d1304207d8bba2204648d6">Ptr</a></td></tr> +<tr class="separator:a2280093713d1304207d8bba2204648d6"><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:a4f1f6efd16518a24e8c153f5e126a36f"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_webhook_info.html#a4f1f6efd16518a24e8c153f5e126a36f">url</a></td></tr> +<tr class="separator:a4f1f6efd16518a24e8c153f5e126a36f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:acf1dda44e0f4bf867cad1fd5b0099fca"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_webhook_info.html#acf1dda44e0f4bf867cad1fd5b0099fca">hasCustomCertificate</a></td></tr> +<tr class="separator:acf1dda44e0f4bf867cad1fd5b0099fca"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae709688fe3890a2e34981cf9d1470726"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_webhook_info.html#ae709688fe3890a2e34981cf9d1470726">pendingUpdateCount</a></td></tr> +<tr class="separator:ae709688fe3890a2e34981cf9d1470726"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6c9cb25b5867db8988e45c53a6f36ab5"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_webhook_info.html#a6c9cb25b5867db8988e45c53a6f36ab5">lastErrorDate</a></td></tr> +<tr class="separator:a6c9cb25b5867db8988e45c53a6f36ab5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a480255d4d60fd3d669463ef86c31f4e4"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_webhook_info.html#a480255d4d60fd3d669463ef86c31f4e4">lastErrorMessage</a></td></tr> +<tr class="separator:a480255d4d60fd3d669463ef86c31f4e4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abccb7180f3a2ee8c9fe01e51464fd79b"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_webhook_info.html#abccb7180f3a2ee8c9fe01e51464fd79b">maxConnections</a></td></tr> +<tr class="separator:abccb7180f3a2ee8c9fe01e51464fd79b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5a145b95d4d15992ac253b6f1ef834ce"><td class="memItemLeft" align="right" valign="top">std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_webhook_info.html#a5a145b95d4d15992ac253b6f1ef834ce">allowedUpdates</a></td></tr> +<tr class="separator:a5a145b95d4d15992ac253b6f1ef834ce"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Contains information about the current status of a webhook. </p> + +<p class="definition">Definition at line <a class="el" href="_webhook_info_8h_source.html#l00018">18</a> of file <a class="el" href="_webhook_info_8h_source.html">WebhookInfo.h</a>.</p> +</div><h2 class="groupheader">Member Typedef Documentation</h2> +<a id="a2280093713d1304207d8bba2204648d6"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a2280093713d1304207d8bba2204648d6">◆ </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_webhook_info.html">WebhookInfo</a>> <a class="el" href="class_tg_bot_1_1_webhook_info.html#a2280093713d1304207d8bba2204648d6">TgBot::WebhookInfo::Ptr</a></td> + </tr> + </table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_webhook_info_8h_source.html#l00020">20</a> of file <a class="el" href="_webhook_info_8h_source.html">WebhookInfo.h</a>.</p> + +</div> +</div> +<h2 class="groupheader">Member Data Documentation</h2> +<a id="a5a145b95d4d15992ac253b6f1ef834ce"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a5a145b95d4d15992ac253b6f1ef834ce">◆ </a></span>allowedUpdates</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::vector<std::string> TgBot::WebhookInfo::allowedUpdates</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Optional. A list of update types the bot is subscribed to. Defaults to all update types </p> + +<p class="definition">Definition at line <a class="el" href="_webhook_info_8h_source.html#l00055">55</a> of file <a class="el" href="_webhook_info_8h_source.html">WebhookInfo.h</a>.</p> + +</div> +</div> +<a id="acf1dda44e0f4bf867cad1fd5b0099fca"></a> +<h2 class="memtitle"><span class="permalink"><a href="#acf1dda44e0f4bf867cad1fd5b0099fca">◆ </a></span>hasCustomCertificate</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool TgBot::WebhookInfo::hasCustomCertificate</td> + </tr> + </table> +</div><div class="memdoc"> +<p>True, if a custom certificate was provided for webhook certificate checks </p> + +<p class="definition">Definition at line <a class="el" href="_webhook_info_8h_source.html#l00030">30</a> of file <a class="el" href="_webhook_info_8h_source.html">WebhookInfo.h</a>.</p> + +</div> +</div> +<a id="a6c9cb25b5867db8988e45c53a6f36ab5"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a6c9cb25b5867db8988e45c53a6f36ab5">◆ </a></span>lastErrorDate</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int32_t TgBot::WebhookInfo::lastErrorDate</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Optional. Unix time for the most recent error that happened when trying to deliver an update via webhook </p> + +<p class="definition">Definition at line <a class="el" href="_webhook_info_8h_source.html#l00040">40</a> of file <a class="el" href="_webhook_info_8h_source.html">WebhookInfo.h</a>.</p> + +</div> +</div> +<a id="a480255d4d60fd3d669463ef86c31f4e4"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a480255d4d60fd3d669463ef86c31f4e4">◆ </a></span>lastErrorMessage</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string TgBot::WebhookInfo::lastErrorMessage</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Optional. Error message in human - readable format for the most recent error that happened when trying to deliver an update via webhook </p> + +<p class="definition">Definition at line <a class="el" href="_webhook_info_8h_source.html#l00045">45</a> of file <a class="el" href="_webhook_info_8h_source.html">WebhookInfo.h</a>.</p> + +</div> +</div> +<a id="abccb7180f3a2ee8c9fe01e51464fd79b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#abccb7180f3a2ee8c9fe01e51464fd79b">◆ </a></span>maxConnections</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int32_t TgBot::WebhookInfo::maxConnections</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Optional. Maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery </p> + +<p class="definition">Definition at line <a class="el" href="_webhook_info_8h_source.html#l00050">50</a> of file <a class="el" href="_webhook_info_8h_source.html">WebhookInfo.h</a>.</p> + +</div> +</div> +<a id="ae709688fe3890a2e34981cf9d1470726"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ae709688fe3890a2e34981cf9d1470726">◆ </a></span>pendingUpdateCount</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int32_t TgBot::WebhookInfo::pendingUpdateCount</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Number of updates awaiting delivery </p> + +<p class="definition">Definition at line <a class="el" href="_webhook_info_8h_source.html#l00035">35</a> of file <a class="el" href="_webhook_info_8h_source.html">WebhookInfo.h</a>.</p> + +</div> +</div> +<a id="a4f1f6efd16518a24e8c153f5e126a36f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a4f1f6efd16518a24e8c153f5e126a36f">◆ </a></span>url</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string TgBot::WebhookInfo::url</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Webhook URL, may be empty if webhook is not set up. </p> + +<p class="definition">Definition at line <a class="el" href="_webhook_info_8h_source.html#l00025">25</a> of file <a class="el" href="_webhook_info_8h_source.html">WebhookInfo.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="_webhook_info_8h_source.html">WebhookInfo.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_webhook_info.html">WebhookInfo</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> |