Arguments for Api::getUpdates. More...

#include <Types.h>

Public Attributes
std::int32_t	offset = 0
	Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset higher than its update_id. The negative offset can be specified to retrieve updates starting from -offset update from the end of the updates queue. All previous updates will be forgotten.
std::int32_t	limit = 100
	Limits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults to 100.
std::int32_t	timeout = 0
	Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling. Should be positive, short polling should be used for testing purposes only.
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 getUpdates, so unwanted updates may be received for a short period of time.

Detailed Description

Arguments for Api::getUpdates.

Definition at line 16679 of file Types.h.

Member Data Documentation

◆ allowedUpdates

std::vector<std::string> TgBot::GetUpdatesArgs::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 getUpdates, so unwanted updates may be received for a short period of time.

Definition at line 16715 of file Types.h.

◆ limit

std::int32_t TgBot::GetUpdatesArgs::limit = 100

Limits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults to 100.

Definition at line 16695 of file Types.h.

◆ offset

std::int32_t TgBot::GetUpdatesArgs::offset = 0

Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset higher than its update_id. The negative offset can be specified to retrieve updates starting from -offset update from the end of the updates queue. All previous updates will be forgotten.

Definition at line 16689 of file Types.h.

◆ timeout

std::int32_t TgBot::GetUpdatesArgs::timeout = 0

Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling. Should be positive, short polling should be used for testing purposes only.

Definition at line 16702 of file Types.h.

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

include/tgbot/Types.h