Arguments for Api::getChatGifts. More...

#include <Types.h>

Public Attributes
std::variant< std::int64_t, std::string >	chatId { }
	Unique identifier for the target chat or username of the target channel in the format @username.
bool	excludeFromBlockchain = false
	Pass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram.
bool	excludeLimitedNonUpgradable = false
	Pass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique.
bool	excludeLimitedUpgradable = false
	Pass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique.
bool	excludeSaved = false
	Pass True to exclude gifts that are saved to the chat's profile page. Always False, unless the bot has the can_post_messages administrator right in the channel.
bool	excludeUnique = false
	Pass True to exclude unique gifts.
bool	excludeUnlimited = false
	Pass True to exclude gifts that can be purchased an unlimited number of times.
bool	excludeUnsaved = false
	Pass True to exclude gifts that aren't saved to the chat's profile page. Always True, unless the bot has the can_post_messages administrator right in the channel.
std::int32_t	limit = 0
	The maximum number of gifts to be returned; 1-100. Defaults to 100.
std::string	offset = ""
	Offset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results.
bool	sortByPrice = false
	Pass True to sort results by gift price instead of send date. Sorting is applied before pagination.

Detailed Description

Arguments for Api::getChatGifts.

Definition at line 16400 of file Types.h.

Member Data Documentation

◆ chatId

std::variant<std::int64_t, std::string> TgBot::GetChatGiftsArgs::chatId { }

Unique identifier for the target chat or username of the target channel in the format @username.

Definition at line 16405 of file Types.h.

◆ excludeFromBlockchain

bool TgBot::GetChatGiftsArgs::excludeFromBlockchain = false

Pass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram.

Definition at line 16411 of file Types.h.

◆ excludeLimitedNonUpgradable

bool TgBot::GetChatGiftsArgs::excludeLimitedNonUpgradable = false

Pass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique.

Definition at line 16417 of file Types.h.

◆ excludeLimitedUpgradable

bool TgBot::GetChatGiftsArgs::excludeLimitedUpgradable = false

Pass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique.

Definition at line 16423 of file Types.h.

◆ excludeSaved

bool TgBot::GetChatGiftsArgs::excludeSaved = false

Pass True to exclude gifts that are saved to the chat's profile page. Always False, unless the bot has the can_post_messages administrator right in the channel.

Definition at line 16430 of file Types.h.

◆ excludeUnique

bool TgBot::GetChatGiftsArgs::excludeUnique = false

Pass True to exclude unique gifts.

Definition at line 16435 of file Types.h.

◆ excludeUnlimited

bool TgBot::GetChatGiftsArgs::excludeUnlimited = false

Pass True to exclude gifts that can be purchased an unlimited number of times.

Definition at line 16441 of file Types.h.

◆ excludeUnsaved

bool TgBot::GetChatGiftsArgs::excludeUnsaved = false

Pass True to exclude gifts that aren't saved to the chat's profile page. Always True, unless the bot has the can_post_messages administrator right in the channel.

Definition at line 16448 of file Types.h.

◆ limit

std::int32_t TgBot::GetChatGiftsArgs::limit = 0

The maximum number of gifts to be returned; 1-100. Defaults to 100.

Definition at line 16453 of file Types.h.

◆ offset

std::string TgBot::GetChatGiftsArgs::offset = ""

Offset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results.

Definition at line 16459 of file Types.h.

◆ sortByPrice

bool TgBot::GetChatGiftsArgs::sortByPrice = false

Pass True to sort results by gift price instead of send date. Sorting is applied before pagination.

Definition at line 16465 of file Types.h.

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

include/tgbot/Types.h

Public Attributes