Arguments for Api::setWebhook. More...

#include <Types.h>

Public Attributes
std::string	url { }
	HTTPS URL to send updates to. Use an empty string to remove webhook integration.
std::shared_ptr< InputFile >	certificate = nullptr
	Upload your public key certificate so that the root certificate in use can be checked. See our self-signed guide for details.
std::int32_t	maxConnections = 40
	The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40. Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput.
std::vector< std::string >	allowedUpdates = { }
	A JSON-serialized list of the update types you want your bot to receive. For example, specify ["message", "edited_channel_post", "callback_query"] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member, message_reaction, and message_reaction_count (default). If not specified, the previous setting will be used.Please note that this parameter doesn't affect updates created before the call to the setWebhook, so unwanted updates may be received for a short period of time.
std::string	ipAddress = ""
	The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS.
bool	dropPendingUpdates = false
	Pass True to drop all pending updates.
std::string	secretToken = ""
	A secret token to be sent in a header “X-Telegram-Bot-Api-Secret-Token” in every webhook request, 1-256 characters. Only characters A-Z, a-z, 0-9, _ and - are allowed. The header is useful to ensure that the request comes from a webhook set by you.

Detailed Description

Arguments for Api::setWebhook.

Definition at line 20947 of file Types.h.

Member Data Documentation

◆ allowedUpdates

std::vector<std::string> TgBot::SetWebhookArgs::allowedUpdates = { }

A JSON-serialized list of the update types you want your bot to receive. For example, specify ["message", "edited_channel_post", "callback_query"] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member, message_reaction, and message_reaction_count (default). If not specified, the previous setting will be used.Please note that this parameter doesn't affect updates created before the call to the setWebhook, so unwanted updates may be received for a short period of time.

Definition at line 20979 of file Types.h.

◆ certificate

std::shared_ptr<InputFile> TgBot::SetWebhookArgs::certificate = nullptr

Upload your public key certificate so that the root certificate in use can be checked. See our self-signed guide for details.

Definition at line 20958 of file Types.h.

◆ dropPendingUpdates

bool TgBot::SetWebhookArgs::dropPendingUpdates = false

Pass True to drop all pending updates.

Definition at line 20990 of file Types.h.

◆ ipAddress

std::string TgBot::SetWebhookArgs::ipAddress = ""

The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS.

Definition at line 20985 of file Types.h.

◆ maxConnections

std::int32_t TgBot::SetWebhookArgs::maxConnections = 40

The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40. Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput.

Definition at line 20966 of file Types.h.

◆ secretToken

std::string TgBot::SetWebhookArgs::secretToken = ""

A secret token to be sent in a header “X-Telegram-Bot-Api-Secret-Token” in every webhook request, 1-256 characters. Only characters A-Z, a-z, 0-9, _ and - are allowed. The header is useful to ensure that the request comes from a webhook set by you.

Definition at line 20998 of file Types.h.

◆ url

std::string TgBot::SetWebhookArgs::url { }

HTTPS URL to send updates to. Use an empty string to remove webhook integration.

Definition at line 20952 of file Types.h.

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

include/tgbot/Types.h

Public Attributes