This object represents a gift that can be sent by the bot. More...

#include <Types.h>

Public Types
using	Ptr = std::shared_ptr<Gift>

Public Attributes
std::string	id { }
	Unique identifier of the gift.
std::shared_ptr< Sticker >	sticker { }
	The sticker that represents the gift.
std::int32_t	starCount { }
	The number of Telegram Stars that must be paid to send the sticker.
std::optional< std::int32_t >	upgradeStarCount { }
	Optional. The number of Telegram Stars that must be paid to upgrade the gift to a unique one.
std::optional< bool >	isPremium { }
	Optional. True, if the gift can only be purchased by Telegram Premium subscribers.
std::optional< bool >	hasColors { }
	Optional. True, if the gift can be used (after being upgraded) to customize a user's appearance.
std::optional< std::int32_t >	totalCount { }
	Optional. The total number of gifts of this type that can be sent by all users; for limited gifts only.
std::optional< std::int32_t >	remainingCount { }
	Optional. The number of remaining gifts of this type that can be sent by all users; for limited gifts only.
std::optional< std::int32_t >	personalTotalCount { }
	Optional. The total number of gifts of this type that can be sent by the bot; for limited gifts only.
std::optional< std::int32_t >	personalRemainingCount { }
	Optional. The number of remaining gifts of this type that can be sent by the bot; for limited gifts only.
std::shared_ptr< GiftBackground >	background { }
	Optional. Background of the gift.
std::optional< std::int32_t >	uniqueGiftVariantCount { }
	Optional. The total number of different unique gifts that can be obtained by upgrading the gift.
std::shared_ptr< Chat >	publisherChat { }
	Optional. Information about the chat that published the gift.

Detailed Description

This object represents a gift that can be sent by the bot.

Definition at line 3646 of file Types.h.

Member Typedef Documentation

◆ Ptr

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

Definition at line 3647 of file Types.h.

Member Data Documentation

◆ background

std::shared_ptr<GiftBackground> TgBot::Gift::background { }

Optional. Background of the gift.

Definition at line 3698 of file Types.h.

◆ hasColors

std::optional<bool> TgBot::Gift::hasColors { }

Optional. True, if the gift can be used (after being upgraded) to customize a user's appearance.

Definition at line 3674 of file Types.h.

◆ id

std::string TgBot::Gift::id { }

Unique identifier of the gift.

Definition at line 3652 of file Types.h.

◆ isPremium

std::optional<bool> TgBot::Gift::isPremium { }

Optional. True, if the gift can only be purchased by Telegram Premium subscribers.

Definition at line 3669 of file Types.h.

◆ personalRemainingCount

std::optional<std::int32_t> TgBot::Gift::personalRemainingCount { }

Optional. The number of remaining gifts of this type that can be sent by the bot; for limited gifts only.

Definition at line 3694 of file Types.h.

◆ personalTotalCount

std::optional<std::int32_t> TgBot::Gift::personalTotalCount { }

Optional. The total number of gifts of this type that can be sent by the bot; for limited gifts only.

Definition at line 3689 of file Types.h.

◆ publisherChat

std::shared_ptr<Chat> TgBot::Gift::publisherChat { }

Optional. Information about the chat that published the gift.

Definition at line 3707 of file Types.h.

◆ remainingCount

std::optional<std::int32_t> TgBot::Gift::remainingCount { }

Optional. The number of remaining gifts of this type that can be sent by all users; for limited gifts only.

Definition at line 3684 of file Types.h.

◆ starCount

std::int32_t TgBot::Gift::starCount { }

The number of Telegram Stars that must be paid to send the sticker.

Definition at line 3660 of file Types.h.

◆ sticker

std::shared_ptr<Sticker> TgBot::Gift::sticker { }

The sticker that represents the gift.

Definition at line 3656 of file Types.h.

◆ totalCount

std::optional<std::int32_t> TgBot::Gift::totalCount { }

Optional. The total number of gifts of this type that can be sent by all users; for limited gifts only.

Definition at line 3679 of file Types.h.

◆ uniqueGiftVariantCount

std::optional<std::int32_t> TgBot::Gift::uniqueGiftVariantCount { }

Optional. The total number of different unique gifts that can be obtained by upgrading the gift.

Definition at line 3703 of file Types.h.

◆ upgradeStarCount

std::optional<std::int32_t> TgBot::Gift::upgradeStarCount { }

Optional. The number of Telegram Stars that must be paid to upgrade the gift to a unique one.

Definition at line 3665 of file Types.h.

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

include/tgbot/Types.h

Public Types

Public Attributes