diff options
author | Oleg Morozenkov <m@oleg.rocks> | 2018-06-05 19:07:27 +0300 |
---|---|---|
committer | Oleg Morozenkov <m@oleg.rocks> | 2018-06-05 19:07:27 +0300 |
commit | c8d40dccabaaa406faed6c0797a92bac811c9d0f (patch) | |
tree | bacf9287fbac322e8ecf9c8ae2c505ce6ba8b8b6 /docs/class_tg_bot_1_1_webhook_info.html | |
parent | 1a90b5022d47bc0059214381b74db6fae9767cef (diff) |
Update docs
Diffstat (limited to 'docs/class_tg_bot_1_1_webhook_info.html')
-rw-r--r-- | docs/class_tg_bot_1_1_webhook_info.html | 49 |
1 files changed, 33 insertions, 16 deletions
diff --git a/docs/class_tg_bot_1_1_webhook_info.html b/docs/class_tg_bot_1_1_webhook_info.html index a740846..7bef70e 100644 --- a/docs/class_tg_bot_1_1_webhook_info.html +++ b/docs/class_tg_bot_1_1_webhook_info.html @@ -88,6 +88,9 @@ $(document).ready(function(){initNavTree('class_tg_bot_1_1_webhook_info.html','' </div><!--header--> <div class="contents"> +<p>Contains information about the current status of a webhook. + <a href="class_tg_bot_1_1_webhook_info.html#details">More...</a></p> + <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> @@ -98,24 +101,31 @@ Public Types</h2></td></tr> <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="memdesc:a4f1f6efd16518a24e8c153f5e126a36f"><td class="mdescLeft"> </td><td class="mdescRight">Webhook URL, may be empty if webhook is not set up. <a href="#a4f1f6efd16518a24e8c153f5e126a36f">More...</a><br /></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="memdesc:acf1dda44e0f4bf867cad1fd5b0099fca"><td class="mdescLeft"> </td><td class="mdescRight">True, if a custom certificate was provided for webhook certificate checks. <a href="#acf1dda44e0f4bf867cad1fd5b0099fca">More...</a><br /></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="memdesc:ae709688fe3890a2e34981cf9d1470726"><td class="mdescLeft"> </td><td class="mdescRight">Number of updates awaiting delivery. <a href="#ae709688fe3890a2e34981cf9d1470726">More...</a><br /></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="memdesc:a6c9cb25b5867db8988e45c53a6f36ab5"><td class="mdescLeft"> </td><td class="mdescRight">Optional. Unix time for the most recent error that happened when trying to deliver an update via webhook. <a href="#a6c9cb25b5867db8988e45c53a6f36ab5">More...</a><br /></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="memdesc:a480255d4d60fd3d669463ef86c31f4e4"><td class="mdescLeft"> </td><td class="mdescRight">Optional. Error message in human - readable format for the most recent error that happened when trying to deliver an update via webhook. <a href="#a480255d4d60fd3d669463ef86c31f4e4">More...</a><br /></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="memdesc:abccb7180f3a2ee8c9fe01e51464fd79b"><td class="mdescLeft"> </td><td class="mdescRight">Optional. Maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery. <a href="#abccb7180f3a2ee8c9fe01e51464fd79b">More...</a><br /></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="memdesc:a5a145b95d4d15992ac253b6f1ef834ce"><td class="mdescLeft"> </td><td class="mdescRight">Optional. A list of update types the bot is subscribed to. Defaults to all update types. <a href="#a5a145b95d4d15992ac253b6f1ef834ce">More...</a><br /></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> +<p class="definition">Definition at line <a class="el" href="_webhook_info_8h_source.html#l00019">19</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> @@ -129,7 +139,7 @@ Public Attributes</h2></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> +<p class="definition">Definition at line <a class="el" href="_webhook_info_8h_source.html#l00021">21</a> of file <a class="el" href="_webhook_info_8h_source.html">WebhookInfo.h</a>.</p> </div> </div> @@ -145,9 +155,10 @@ Public Attributes</h2></td></tr> </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> +<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#l00056">56</a> of file <a class="el" href="_webhook_info_8h_source.html">WebhookInfo.h</a>.</p> </div> </div> @@ -162,9 +173,10 @@ Public Attributes</h2></td></tr> </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> +<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#l00031">31</a> of file <a class="el" href="_webhook_info_8h_source.html">WebhookInfo.h</a>.</p> </div> </div> @@ -179,9 +191,10 @@ Public Attributes</h2></td></tr> </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> +<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#l00041">41</a> of file <a class="el" href="_webhook_info_8h_source.html">WebhookInfo.h</a>.</p> </div> </div> @@ -196,9 +209,10 @@ Public Attributes</h2></td></tr> </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> +<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#l00046">46</a> of file <a class="el" href="_webhook_info_8h_source.html">WebhookInfo.h</a>.</p> </div> </div> @@ -213,9 +227,10 @@ Public Attributes</h2></td></tr> </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> +<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#l00051">51</a> of file <a class="el" href="_webhook_info_8h_source.html">WebhookInfo.h</a>.</p> </div> </div> @@ -230,9 +245,10 @@ Public Attributes</h2></td></tr> </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> +<p>Number of updates awaiting delivery. </p> + +<p class="definition">Definition at line <a class="el" href="_webhook_info_8h_source.html#l00036">36</a> of file <a class="el" href="_webhook_info_8h_source.html">WebhookInfo.h</a>.</p> </div> </div> @@ -247,9 +263,10 @@ Public Attributes</h2></td></tr> </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> +<p class="definition">Definition at line <a class="el" href="_webhook_info_8h_source.html#l00026">26</a> of file <a class="el" href="_webhook_info_8h_source.html">WebhookInfo.h</a>.</p> </div> </div> @@ -262,7 +279,7 @@ Public Attributes</h2></td></tr> <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 Mon May 28 2018 13:57:33 for tgbot-cpp by + <li class="footer">Generated on Tue Jun 5 2018 19:07: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> |