Inherits Object.
Description
Represents a gift received by a user.
Public Fields | |
| int53 | sender_user_id_ |
| Identifier of the user that sent the gift; 0 if unknown. | |
| object_ptr< formattedText > | text_ |
| Message added to the gift. | |
| bool | is_private_ |
| True, if the sender and gift text are shown only to the gift receiver; otherwise, everyone are able to see them. | |
| bool | is_saved_ |
| True, if the gift is displayed on the user's profile page; only for the receiver of the gift. | |
| bool | can_be_upgraded_ |
| True, if the gift is a regular gift that can be upgraded to a unique gift; only for the receiver of the gift. | |
| bool | can_be_transferred_ |
| True, if the gift is an upgraded gift that can be transferred to another user; only for the receiver of the gift. | |
| bool | was_refunded_ |
| True, if the gift was refunded and isn't available anymore. | |
| int32 | date_ |
| Point in time (Unix timestamp) when the gift was sent. | |
| object_ptr< SentGift > | gift_ |
| The gift. | |
| int53 | message_id_ |
| Identifier of the message with the gift in the chat with the sender of the gift; can be 0 or an identifier of a deleted message; only for the receiver of the gift. | |
| int53 | sell_star_count_ |
| Number of Telegram Stars that can be claimed by the receiver instead of the regular gift; 0 if the gift can't be sold by the current user. | |
| int53 | prepaid_upgrade_star_count_ |
| Number of Telegram Stars that were paid by the sender for the ability to upgrade the gift. | |
| int53 | transfer_star_count_ |
| Number of Telegram Stars that must be paid to transfer the upgraded gift; only for the receiver of the gift. | |
| int32 | export_date_ |
| Point in time (Unix timestamp) when the upgraded gift can be transferred to TON blockchain as an NFT; 0 if NFT export isn't possible; only for the receiver of the gift. | |
Public Instance Methods | |
| userGift () | |
| userGift (int53 sender_user_id_, object_ptr< formattedText > &&text_, bool is_private_, bool is_saved_, bool can_be_upgraded_, bool can_be_transferred_, bool was_refunded_, int32 date_, object_ptr< SentGift > &&gift_, int53 message_id_, int53 sell_star_count_, int53 prepaid_upgrade_star_count_, int53 transfer_star_count_, int32 export_date_) | |
| void | store (TlStorerToString &s, const char *field_name) const final |
 Public Instance Methods inherited from TlObject | |
| virtual void | store (TlStorerUnsafe &s) const |
| virtual void | store (TlStorerCalcLength &s) const |
| TlObject ()=default | |
| TlObject (const TlObject &)=delete | |
| TlObject & | operator= (const TlObject &)=delete |
| TlObject (TlObject &&)=default | |
| TlObject & | operator= (TlObject &&)=default |
| virtual | ~TlObject ()=default |
Static Public Attributes | |
| static const std::int32_t | ID = -1549944736 |
| Identifier uniquely determining a type of the object. | |
Constructor & Destructor Documentation
◆ userGift() [1/2]
| userGift | ( | ) |
Represents a gift received by a user.
◆ userGift() [2/2]
| userGift | ( | int53 | sender_user_id_, |
| object_ptr< formattedText > && | text_, | ||
| bool | is_private_, | ||
| bool | is_saved_, | ||
| bool | can_be_upgraded_, | ||
| bool | can_be_transferred_, | ||
| bool | was_refunded_, | ||
| int32 | date_, | ||
| object_ptr< SentGift > && | gift_, | ||
| int53 | message_id_, | ||
| int53 | sell_star_count_, | ||
| int53 | prepaid_upgrade_star_count_, | ||
| int53 | transfer_star_count_, | ||
| int32 | export_date_ | ||
| ) |
Represents a gift received by a user.
- Parameters
-
[in] sender_user_id_ Identifier of the user that sent the gift; 0 if unknown. [in] text_ Message added to the gift. [in] is_private_ True, if the sender and gift text are shown only to the gift receiver; otherwise, everyone are able to see them. [in] is_saved_ True, if the gift is displayed on the user's profile page; only for the receiver of the gift. [in] can_be_upgraded_ True, if the gift is a regular gift that can be upgraded to a unique gift; only for the receiver of the gift. [in] can_be_transferred_ True, if the gift is an upgraded gift that can be transferred to another user; only for the receiver of the gift. [in] was_refunded_ True, if the gift was refunded and isn't available anymore. [in] date_ Point in time (Unix timestamp) when the gift was sent. [in] gift_ The gift. [in] message_id_ Identifier of the message with the gift in the chat with the sender of the gift; can be 0 or an identifier of a deleted message; only for the receiver of the gift. [in] sell_star_count_ Number of Telegram Stars that can be claimed by the receiver instead of the regular gift; 0 if the gift can't be sold by the current user. [in] prepaid_upgrade_star_count_ Number of Telegram Stars that were paid by the sender for the ability to upgrade the gift. [in] transfer_star_count_ Number of Telegram Stars that must be paid to transfer the upgraded gift; only for the receiver of the gift. [in] export_date_ Point in time (Unix timestamp) when the upgraded gift can be transferred to TON blockchain as an NFT; 0 if NFT export isn't possible; only for the receiver of the gift.
Method Documentation
◆ store()
|
finalvirtual |
The documentation for this class was generated from the following file:
- td/generate/auto/td/telegram/td_api.h