tgbot-cpp
Loading...
Searching...
No Matches
TgBot::WebhookInfo Struct Reference

Describes the current status of a webhook. More...

#include <Types.h>

Public Types

using Ptr = std::shared_ptr<WebhookInfo>

Public Attributes

std::string url { }
 Webhook URL, may be empty if webhook is not set up.
bool hasCustomCertificate { }
 True, if a custom certificate was provided for webhook certificate checks.
std::int32_t pendingUpdateCount { }
 Number of updates awaiting delivery.
std::optional< std::string > ipAddress { }
 Optional. Currently used webhook IP address.
std::optional< std::int32_t > lastErrorDate { }
 Optional. Unix time for the most recent error that happened when trying to deliver an update via webhook.
std::optional< std::string > lastErrorMessage { }
 Optional. Error message in human-readable format for the most recent error that happened when trying to deliver an update via webhook.
std::optional< std::int32_t > lastSynchronizationErrorDate { }
 Optional. Unix time of the most recent error that happened when trying to synchronize available updates with Telegram datacenters.
std::optional< std::int32_t > maxConnections { }
 Optional. The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery.
std::optional< std::vector< std::string > > allowedUpdates { }
 Optional. A list of update types the bot is subscribed to. Defaults to all update types except chat_member, message_reaction, and message_reaction_count.

Detailed Description

Describes the current status of a webhook.

Definition at line 15359 of file Types.h.

Member Typedef Documentation

◆ Ptr

using TgBot::WebhookInfo::Ptr = std::shared_ptr<WebhookInfo>

Definition at line 15360 of file Types.h.

Member Data Documentation

◆ allowedUpdates

std::optional<std::vector<std::string> > TgBot::WebhookInfo::allowedUpdates { }

Optional. A list of update types the bot is subscribed to. Defaults to all update types except chat_member, message_reaction, and message_reaction_count.

Definition at line 15410 of file Types.h.

◆ hasCustomCertificate

bool TgBot::WebhookInfo::hasCustomCertificate { }

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

Definition at line 15370 of file Types.h.

◆ ipAddress

std::optional<std::string> TgBot::WebhookInfo::ipAddress { }

Optional. Currently used webhook IP address.

Definition at line 15380 of file Types.h.

◆ lastErrorDate

std::optional<std::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 15386 of file Types.h.

◆ lastErrorMessage

std::optional<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 15392 of file Types.h.

◆ lastSynchronizationErrorDate

std::optional<std::int32_t> TgBot::WebhookInfo::lastSynchronizationErrorDate { }

Optional. Unix time of the most recent error that happened when trying to synchronize available updates with Telegram datacenters.

Definition at line 15398 of file Types.h.

◆ maxConnections

std::optional<std::int32_t> TgBot::WebhookInfo::maxConnections { }

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

Definition at line 15404 of file Types.h.

◆ pendingUpdateCount

std::int32_t TgBot::WebhookInfo::pendingUpdateCount { }

Number of updates awaiting delivery.

Definition at line 15375 of file Types.h.

◆ url

std::string TgBot::WebhookInfo::url { }

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

Definition at line 15365 of file Types.h.


The documentation for this struct was generated from the following file: