Describes a service message about a regular gift that was sent or received. More...

#include <Types.h>

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

Public Attributes
std::shared_ptr< Gift >	gift { }
	Information about the gift.
std::optional< std::string >	ownedGiftId { }
	Optional. Unique identifier of the received gift for the bot; only present for gifts received on behalf of business accounts.
std::optional< std::int32_t >	convertStarCount { }
	Optional. Number of Telegram Stars that can be claimed by the receiver by converting the gift; omitted if conversion to Telegram Stars is impossible.
std::optional< std::int32_t >	prepaidUpgradeStarCount { }
	Optional. Number of Telegram Stars that were prepaid for the ability to upgrade the gift.
std::optional< bool >	isUpgradeSeparate { }
	Optional. True, if the gift's upgrade was purchased after the gift was sent.
std::optional< bool >	canBeUpgraded { }
	Optional. True, if the gift can be upgraded to a unique gift.
std::optional< std::string >	text { }
	Optional. Text of the message that was added to the gift.
std::optional< std::vector< std::shared_ptr< MessageEntity > > >	entities { }
	Optional. Special entities that appear in the text.
std::optional< bool >	isPrivate { }
	Optional. True, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them.
std::optional< std::int32_t >	uniqueGiftNumber { }
	Optional. Unique number reserved for this gift when upgraded. See the number field in UniqueGift.

Detailed Description

Describes a service message about a regular gift that was sent or received.

Definition at line 4029 of file Types.h.

Member Typedef Documentation

◆ Ptr

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

Definition at line 4030 of file Types.h.

Member Data Documentation

◆ canBeUpgraded

std::optional<bool> TgBot::GiftInfo::canBeUpgraded { }

Optional. True, if the gift can be upgraded to a unique gift.

Definition at line 4062 of file Types.h.

◆ convertStarCount

std::optional<std::int32_t> TgBot::GiftInfo::convertStarCount { }

Optional. Number of Telegram Stars that can be claimed by the receiver by converting the gift; omitted if conversion to Telegram Stars is impossible.

Definition at line 4047 of file Types.h.

◆ entities

std::optional<std::vector<std::shared_ptr<MessageEntity> > > TgBot::GiftInfo::entities { }

Optional. Special entities that appear in the text.

Definition at line 4072 of file Types.h.

◆ gift

std::shared_ptr<Gift> TgBot::GiftInfo::gift { }

Information about the gift.

Definition at line 4035 of file Types.h.

◆ isPrivate

std::optional<bool> TgBot::GiftInfo::isPrivate { }

Optional. True, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them.

Definition at line 4078 of file Types.h.

◆ isUpgradeSeparate

std::optional<bool> TgBot::GiftInfo::isUpgradeSeparate { }

Optional. True, if the gift's upgrade was purchased after the gift was sent.

Definition at line 4057 of file Types.h.

◆ ownedGiftId

std::optional<std::string> TgBot::GiftInfo::ownedGiftId { }

Optional. Unique identifier of the received gift for the bot; only present for gifts received on behalf of business accounts.

Definition at line 4041 of file Types.h.

◆ prepaidUpgradeStarCount

std::optional<std::int32_t> TgBot::GiftInfo::prepaidUpgradeStarCount { }

Optional. Number of Telegram Stars that were prepaid for the ability to upgrade the gift.

Definition at line 4052 of file Types.h.

◆ text

std::optional<std::string> TgBot::GiftInfo::text { }

Optional. Text of the message that was added to the gift.

Definition at line 4067 of file Types.h.

◆ uniqueGiftNumber

std::optional<std::int32_t> TgBot::GiftInfo::uniqueGiftNumber { }

Optional. Unique number reserved for this gift when upgraded. See the number field in UniqueGift.

Definition at line 4084 of file Types.h.

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

include/tgbot/Types.h

Public Types

Public Attributes