Inherits Object.
Description
Describes a gift that can be sent to another user or channel chat.
Public Fields | |
| int64 | id_ |
| Unique identifier of the gift. | |
| int53 | publisher_chat_id_ |
| Identifier of the chat that published the gift; 0 if none. | |
| object_ptr< sticker > | sticker_ |
| The sticker representing the gift. | |
| int53 | star_count_ |
| Number of Telegram Stars that must be paid for the gift. | |
| int53 | default_sell_star_count_ |
| Number of Telegram Stars that can be claimed by the receiver instead of the regular gift by default. If the gift was paid with just bought Telegram Stars, then full value can be claimed. | |
| int53 | upgrade_star_count_ |
| Number of Telegram Stars that must be paid to upgrade the gift; 0 if upgrade isn't possible. | |
| int32 | upgrade_variant_count_ |
| Number of unique gift variants that are available for the upgraded gift; 0 if unknown. | |
| bool | has_colors_ |
| True, if the gift can be used to customize the user's name, and backgrounds of profile photo, reply header, and link preview. | |
| bool | is_for_birthday_ |
| True, if the gift is a birthday gift. | |
| bool | is_premium_ |
| True, if the gift can be bought only by Telegram Premium subscribers. | |
| object_ptr< giftAuction > | auction_info_ |
| Information about the auction on which the gift can be purchased; may be null if the gift can be purchased directly. | |
| int32 | next_send_date_ |
| Point in time (Unix timestamp) when the gift can be sent next time by the current user; may be 0 or a date in the past. If the date is in the future, then call canSendGift to get the reason, why the gift can't be sent now. | |
| object_ptr< giftPurchaseLimits > | user_limits_ |
| Number of times the gift can be purchased by the current user; may be null if not limited. | |
| object_ptr< giftPurchaseLimits > | overall_limits_ |
| Number of times the gift can be purchased all users; may be null if not limited. | |
| object_ptr< giftBackground > | background_ |
| Background of the gift. | |
| int32 | first_send_date_ |
| Point in time (Unix timestamp) when the gift was send for the first time; for sold out gifts only. | |
| int32 | last_send_date_ |
| Point in time (Unix timestamp) when the gift was send for the last time; for sold out gifts only. | |
Public Instance Methods | |
| gift () | |
| gift (int64 id_, int53 publisher_chat_id_, object_ptr< sticker > &&sticker_, int53 star_count_, int53 default_sell_star_count_, int53 upgrade_star_count_, int32 upgrade_variant_count_, bool has_colors_, bool is_for_birthday_, bool is_premium_, object_ptr< giftAuction > &&auction_info_, int32 next_send_date_, object_ptr< giftPurchaseLimits > &&user_limits_, object_ptr< giftPurchaseLimits > &&overall_limits_, object_ptr< giftBackground > &&background_, int32 first_send_date_, int32 last_send_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 = 1567244615 |
| Identifier uniquely determining a type of the object. | |
Constructor & Destructor Documentation
◆ gift() [1/2]
| gift | ( | ) |
Describes a gift that can be sent to another user or channel chat.
◆ gift() [2/2]
| gift | ( | int64 | id_, |
| int53 | publisher_chat_id_, | ||
| object_ptr< sticker > && | sticker_, | ||
| int53 | star_count_, | ||
| int53 | default_sell_star_count_, | ||
| int53 | upgrade_star_count_, | ||
| int32 | upgrade_variant_count_, | ||
| bool | has_colors_, | ||
| bool | is_for_birthday_, | ||
| bool | is_premium_, | ||
| object_ptr< giftAuction > && | auction_info_, | ||
| int32 | next_send_date_, | ||
| object_ptr< giftPurchaseLimits > && | user_limits_, | ||
| object_ptr< giftPurchaseLimits > && | overall_limits_, | ||
| object_ptr< giftBackground > && | background_, | ||
| int32 | first_send_date_, | ||
| int32 | last_send_date_ | ||
| ) |
Describes a gift that can be sent to another user or channel chat.
- Parameters
-
[in] id_ Unique identifier of the gift. [in] publisher_chat_id_ Identifier of the chat that published the gift; 0 if none. [in] sticker_ The sticker representing the gift. [in] star_count_ Number of Telegram Stars that must be paid for the gift. [in] default_sell_star_count_ Number of Telegram Stars that can be claimed by the receiver instead of the regular gift by default. If the gift was paid with just bought Telegram Stars, then full value can be claimed. [in] upgrade_star_count_ Number of Telegram Stars that must be paid to upgrade the gift; 0 if upgrade isn't possible. [in] upgrade_variant_count_ Number of unique gift variants that are available for the upgraded gift; 0 if unknown. [in] has_colors_ True, if the gift can be used to customize the user's name, and backgrounds of profile photo, reply header, and link preview. [in] is_for_birthday_ True, if the gift is a birthday gift. [in] is_premium_ True, if the gift can be bought only by Telegram Premium subscribers. [in] auction_info_ Information about the auction on which the gift can be purchased; may be null if the gift can be purchased directly. [in] next_send_date_ Point in time (Unix timestamp) when the gift can be sent next time by the current user; may be 0 or a date in the past. If the date is in the future, then call canSendGift to get the reason, why the gift can't be sent now. [in] user_limits_ Number of times the gift can be purchased by the current user; may be null if not limited. [in] overall_limits_ Number of times the gift can be purchased all users; may be null if not limited. [in] background_ Background of the gift. [in] first_send_date_ Point in time (Unix timestamp) when the gift was send for the first time; for sold out gifts only. [in] last_send_date_ Point in time (Unix timestamp) when the gift was send for the last time; for sold out gifts only.
Method Documentation
◆ store()
|
finalvirtual |
The documentation for this class was generated from the following file:
- td/generate/auto/td/telegram/td_api.h