From 985837f2152383c304d043bd4dc8af23914b112f Mon Sep 17 00:00:00 2001 From: Oleg Morozenkov Date: Mon, 2 Jan 2017 23:05:43 +0300 Subject: Docs --- docs/class_tg_bot_1_1_webhook_info.html | 271 ++++++++++++++++++++++++++++++++ 1 file changed, 271 insertions(+) create mode 100644 docs/class_tg_bot_1_1_webhook_info.html (limited to 'docs/class_tg_bot_1_1_webhook_info.html') 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..9cced07 --- /dev/null +++ b/docs/class_tg_bot_1_1_webhook_info.html @@ -0,0 +1,271 @@ + + + + + + + +tgbot-cpp: TgBot::WebhookInfo Class Reference + + + + + + + + + + + + + + +
+
+ + + + + + +
+
tgbot-cpp +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Public Types | +Public Attributes | +List of all members
+
+
TgBot::WebhookInfo Class Reference
Types
+
+
+ +

#include <WebhookInfo.h>

+ + + + +

+Public Types

typedef std::shared_ptr< WebhookInfo > Ptr
 
+ + + + + + + + + + + + + + + +

+Public Attributes

std::string url
 
bool hasCustomCertificate
 
int32_t pendingUpdateCount
 
int32_t lastErrorDate
 
std::string lastErrorMessage
 
int32_t maxConnections
 
std::vector< std::string > allowedUpdates
 
+

Detailed Description

+

Contains information about the current status of a webhook.

+ +

Definition at line 18 of file WebhookInfo.h.

+

Member Typedef Documentation

+ +

◆ Ptr

+ +
+
+ + + + +
typedef std::shared_ptr<WebhookInfo> TgBot::WebhookInfo::Ptr
+
+ +

Definition at line 20 of file WebhookInfo.h.

+ +
+
+

Member Data Documentation

+ +

◆ allowedUpdates

+ +
+
+ + + + +
std::vector<std::string> TgBot::WebhookInfo::allowedUpdates
+
+

Optional. A list of update types the bot is subscribed to. Defaults to all update types

+ +

Definition at line 55 of file WebhookInfo.h.

+ +
+
+ +

◆ hasCustomCertificate

+ +
+
+ + + + +
bool TgBot::WebhookInfo::hasCustomCertificate
+
+

True, if a custom certificate was provided for webhook certificate checks

+ +

Definition at line 30 of file WebhookInfo.h.

+ +
+
+ +

◆ lastErrorDate

+ +
+
+ + + + +
int32_t TgBot::WebhookInfo::lastErrorDate
+
+

Optional. Unix time for the most recent error that happened when trying to deliver an update via webhook

+ +

Definition at line 40 of file WebhookInfo.h.

+ +
+
+ +

◆ lastErrorMessage

+ +
+
+ + + + +
std::string TgBot::WebhookInfo::lastErrorMessage
+
+

Optional. Error message in human - readable format for the most recent error that happened when trying to deliver an update via webhook

+ +

Definition at line 45 of file WebhookInfo.h.

+ +
+
+ +

◆ maxConnections

+ +
+
+ + + + +
int32_t TgBot::WebhookInfo::maxConnections
+
+

Optional. Maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery

+ +

Definition at line 50 of file WebhookInfo.h.

+ +
+
+ +

◆ pendingUpdateCount

+ +
+
+ + + + +
int32_t TgBot::WebhookInfo::pendingUpdateCount
+
+

Number of updates awaiting delivery

+ +

Definition at line 35 of file WebhookInfo.h.

+ +
+
+ +

◆ url

+ +
+
+ + + + +
std::string TgBot::WebhookInfo::url
+
+

Webhook URL, may be empty if webhook is not set up.

+ +

Definition at line 25 of file WebhookInfo.h.

+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + -- cgit v1.2.3