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

Arguments for Api::getUserGifts. More...

#include <Types.h>

Public Attributes

std::int64_t userId { }
 Unique identifier of the user.
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 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.
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::getUserGifts.

Definition at line 16739 of file Types.h.

Member Data Documentation

◆ excludeFromBlockchain

bool TgBot::GetUserGiftsArgs::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 16749 of file Types.h.

◆ excludeLimitedNonUpgradable

bool TgBot::GetUserGiftsArgs::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 16755 of file Types.h.

◆ excludeLimitedUpgradable

bool TgBot::GetUserGiftsArgs::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 16761 of file Types.h.

◆ excludeUnique

bool TgBot::GetUserGiftsArgs::excludeUnique = false

Pass True to exclude unique gifts.

Definition at line 16766 of file Types.h.

◆ excludeUnlimited

bool TgBot::GetUserGiftsArgs::excludeUnlimited = false

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

Definition at line 16772 of file Types.h.

◆ limit

std::int32_t TgBot::GetUserGiftsArgs::limit = 0

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

Definition at line 16777 of file Types.h.

◆ offset

std::string TgBot::GetUserGiftsArgs::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 16783 of file Types.h.

◆ sortByPrice

bool TgBot::GetUserGiftsArgs::sortByPrice = false

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

Definition at line 16789 of file Types.h.

◆ userId

std::int64_t TgBot::GetUserGiftsArgs::userId { }

Unique identifier of the user.

Definition at line 16743 of file Types.h.


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