tdlib-obf API
Reference documentation for the public tdlib-obf API, generated from TDLib schemas and public headers
Loading...
Searching...
No Matches
td::td_api::receivedGift Class Referencefinal

#include </home/runner/work/tdlib-obf/tdlib-obf/td/generate/auto/td/telegram/td_api.h>

Inheritance diagram for td::td_api::receivedGift:
td::td_api::Object td::TlObject

Public Member Functions

 receivedGift ()
 
 receivedGift (string const &received_gift_id_, object_ptr< MessageSender > &&sender_id_, object_ptr< formattedText > &&text_, int32 unique_gift_number_, bool is_private_, bool is_saved_, bool is_pinned_, bool can_be_upgraded_, bool can_be_transferred_, bool was_refunded_, int32 date_, object_ptr< SentGift > &&gift_, array< int32 > &&collection_ids_, int53 sell_star_count_, int53 prepaid_upgrade_star_count_, bool is_upgrade_separate_, int53 transfer_star_count_, int53 drop_original_details_star_count_, int32 next_transfer_date_, int32 next_resale_date_, int32 export_date_, string const &prepaid_upgrade_hash_, int32 craft_date_)
 
void store (TlStorerToString &s, const char *field_name) const final
 
- Public Member Functions inherited from td::TlObject
virtual void store (TlStorerUnsafe &s) const
 
virtual void store (TlStorerCalcLength &s) const
 
 TlObject ()=default
 
 TlObject (const TlObject &)=delete
 
TlObjectoperator= (const TlObject &)=delete
 
 TlObject (TlObject &&)=default
 
TlObjectoperator= (TlObject &&)=default
 
virtual ~TlObject ()=default
 

Public Attributes

string received_gift_id_
 Unique identifier of the received gift for the current user; only for the receiver of the gift.
 
object_ptr< MessageSendersender_id_
 Identifier of a user or a chat that sent the gift; may be null if unknown.
 
object_ptr< formattedTexttext_
 Message added to the gift.
 
int32 unique_gift_number_
 Unique number of the gift among gifts upgraded from the same gift after upgrade; 0 if yet unassigned.
 
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 chat&#x27;s profile page; only for the receiver of the gift.
 
bool is_pinned_
 True, if the gift is pinned to the top of the chat&#x27;s profile page.
 
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 owner; only for the receiver of the gift.
 
bool was_refunded_
 True, if the gift was refunded and isn&#x27;t available anymore.
 
int32 date_
 Point in time (Unix timestamp) when the gift was sent.
 
object_ptr< SentGiftgift_
 The gift.
 
array< int32collection_ids_
 Identifiers of collections to which the gift is added; 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&#x27;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.
 
bool is_upgrade_separate_
 True, if the upgrade was bought after the gift was sent. In this case, prepaid upgrade cost must not be added to the gift cost.
 
int53 transfer_star_count_
 Number of Telegram Stars that must be paid to transfer the upgraded gift; only for the receiver of the gift.
 
int53 drop_original_details_star_count_
 Number of Telegram Stars that must be paid to drop original details of the upgraded gift; 0 if not available; only for the receiver of the gift.
 
int32 next_transfer_date_
 Point in time (Unix timestamp) when the gift can be transferred to another owner; can be in the past; 0 if the gift can be transferred immediately or transfer isn&#x27;t possible; only for the receiver of the gift.
 
int32 next_resale_date_
 Point in time (Unix timestamp) when the gift can be resold to another user; can be in the past; 0 if the gift can&#x27;t be resold; only for the receiver of the gift.
 
int32 export_date_
 Point in time (Unix timestamp) when the upgraded gift can be transferred to the TON blockchain as an NFT; can be in the past; 0 if NFT export isn&#x27;t possible; only for the receiver of the gift.
 
string prepaid_upgrade_hash_
 If non-empty, then the user can pay for an upgrade of the gift using buyGiftUpgrade.
 
int32 craft_date_
 Point in time (Unix timestamp) when the gift can be used to craft another gift can be in the past; only for the receiver of the gift.
 

Static Public Attributes

static const std::int32_t ID = -389770324
 Identifier uniquely determining a type of the object.
 

Detailed Description

Represents a gift received by a user or a chat.

Definition at line 58521 of file td_api.h.

Constructor & Destructor Documentation

◆ receivedGift() [1/2]

td::td_api::receivedGift::receivedGift ( )

Represents a gift received by a user or a chat.

◆ receivedGift() [2/2]

td::td_api::receivedGift::receivedGift ( string const &  received_gift_id_,
object_ptr< MessageSender > &&  sender_id_,
object_ptr< formattedText > &&  text_,
int32  unique_gift_number_,
bool  is_private_,
bool  is_saved_,
bool  is_pinned_,
bool  can_be_upgraded_,
bool  can_be_transferred_,
bool  was_refunded_,
int32  date_,
object_ptr< SentGift > &&  gift_,
array< int32 > &&  collection_ids_,
int53  sell_star_count_,
int53  prepaid_upgrade_star_count_,
bool  is_upgrade_separate_,
int53  transfer_star_count_,
int53  drop_original_details_star_count_,
int32  next_transfer_date_,
int32  next_resale_date_,
int32  export_date_,
string const &  prepaid_upgrade_hash_,
int32  craft_date_ 
)

Represents a gift received by a user or a chat.

Parameters
[in]received_gift_id_Unique identifier of the received gift for the current user; only for the receiver of the gift.
[in]sender_id_Identifier of a user or a chat that sent the gift; may be null if unknown.
[in]text_Message added to the gift.
[in]unique_gift_number_Unique number of the gift among gifts upgraded from the same gift after upgrade; 0 if yet unassigned.
[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 chat&#x27;s profile page; only for the receiver of the gift.
[in]is_pinned_True, if the gift is pinned to the top of the chat&#x27;s profile page.
[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 owner; only for the receiver of the gift.
[in]was_refunded_True, if the gift was refunded and isn&#x27;t available anymore.
[in]date_Point in time (Unix timestamp) when the gift was sent.
[in]gift_The gift.
[in]collection_ids_Identifiers of collections to which the gift is added; 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&#x27;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]is_upgrade_separate_True, if the upgrade was bought after the gift was sent. In this case, prepaid upgrade cost must not be added to the gift cost.
[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]drop_original_details_star_count_Number of Telegram Stars that must be paid to drop original details of the upgraded gift; 0 if not available; only for the receiver of the gift.
[in]next_transfer_date_Point in time (Unix timestamp) when the gift can be transferred to another owner; can be in the past; 0 if the gift can be transferred immediately or transfer isn&#x27;t possible; only for the receiver of the gift.
[in]next_resale_date_Point in time (Unix timestamp) when the gift can be resold to another user; can be in the past; 0 if the gift can&#x27;t be resold; only for the receiver of the gift.
[in]export_date_Point in time (Unix timestamp) when the upgraded gift can be transferred to the TON blockchain as an NFT; can be in the past; 0 if NFT export isn&#x27;t possible; only for the receiver of the gift.
[in]prepaid_upgrade_hash_If non-empty, then the user can pay for an upgrade of the gift using buyGiftUpgrade.
[in]craft_date_Point in time (Unix timestamp) when the gift can be used to craft another gift can be in the past; only for the receiver of the gift.

Member Function Documentation

◆ store()

void td::td_api::receivedGift::store ( TlStorerToString &  s,
const char *  field_name 
) const
finalvirtual

Helper function for to_string method. Appends string representation of the object to the storer.

Parameters
[in]sStorer to which object string representation will be appended.
[in]field_nameObject field_name if applicable.

Implements td::TlObject.

Member Data Documentation

◆ can_be_transferred_

bool td::td_api::receivedGift::can_be_transferred_

True, if the gift is an upgraded gift that can be transferred to another owner; only for the receiver of the gift.

Definition at line 58548 of file td_api.h.

◆ can_be_upgraded_

bool td::td_api::receivedGift::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.

Definition at line 58546 of file td_api.h.

◆ collection_ids_

array<int32> td::td_api::receivedGift::collection_ids_

Identifiers of collections to which the gift is added; only for the receiver of the gift.

Definition at line 58556 of file td_api.h.

◆ craft_date_

int32 td::td_api::receivedGift::craft_date_

Point in time (Unix timestamp) when the gift can be used to craft another gift can be in the past; only for the receiver of the gift.

Definition at line 58576 of file td_api.h.

◆ date_

int32 td::td_api::receivedGift::date_

Point in time (Unix timestamp) when the gift was sent.

Definition at line 58552 of file td_api.h.

◆ drop_original_details_star_count_

int53 td::td_api::receivedGift::drop_original_details_star_count_

Number of Telegram Stars that must be paid to drop original details of the upgraded gift; 0 if not available; only for the receiver of the gift.

Definition at line 58566 of file td_api.h.

◆ export_date_

int32 td::td_api::receivedGift::export_date_

Point in time (Unix timestamp) when the upgraded gift can be transferred to the TON blockchain as an NFT; can be in the past; 0 if NFT export isn&#x27;t possible; only for the receiver of the gift.

Definition at line 58572 of file td_api.h.

◆ gift_

object_ptr<SentGift> td::td_api::receivedGift::gift_

The gift.

Definition at line 58554 of file td_api.h.

◆ ID

const std::int32_t td::td_api::receivedGift::ID = -389770324
static

Identifier uniquely determining a type of the object.

Definition at line 58613 of file td_api.h.

◆ is_pinned_

bool td::td_api::receivedGift::is_pinned_

True, if the gift is pinned to the top of the chat&#x27;s profile page.

Definition at line 58544 of file td_api.h.

◆ is_private_

bool td::td_api::receivedGift::is_private_

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

Definition at line 58540 of file td_api.h.

◆ is_saved_

bool td::td_api::receivedGift::is_saved_

True, if the gift is displayed on the chat&#x27;s profile page; only for the receiver of the gift.

Definition at line 58542 of file td_api.h.

◆ is_upgrade_separate_

bool td::td_api::receivedGift::is_upgrade_separate_

True, if the upgrade was bought after the gift was sent. In this case, prepaid upgrade cost must not be added to the gift cost.

Definition at line 58562 of file td_api.h.

◆ next_resale_date_

int32 td::td_api::receivedGift::next_resale_date_

Point in time (Unix timestamp) when the gift can be resold to another user; can be in the past; 0 if the gift can&#x27;t be resold; only for the receiver of the gift.

Definition at line 58570 of file td_api.h.

◆ next_transfer_date_

int32 td::td_api::receivedGift::next_transfer_date_

Point in time (Unix timestamp) when the gift can be transferred to another owner; can be in the past; 0 if the gift can be transferred immediately or transfer isn&#x27;t possible; only for the receiver of the gift.

Definition at line 58568 of file td_api.h.

◆ prepaid_upgrade_hash_

string td::td_api::receivedGift::prepaid_upgrade_hash_

If non-empty, then the user can pay for an upgrade of the gift using buyGiftUpgrade.

Definition at line 58574 of file td_api.h.

◆ prepaid_upgrade_star_count_

int53 td::td_api::receivedGift::prepaid_upgrade_star_count_

Number of Telegram Stars that were paid by the sender for the ability to upgrade the gift.

Definition at line 58560 of file td_api.h.

◆ received_gift_id_

string td::td_api::receivedGift::received_gift_id_

Unique identifier of the received gift for the current user; only for the receiver of the gift.

Definition at line 58532 of file td_api.h.

◆ sell_star_count_

int53 td::td_api::receivedGift::sell_star_count_

Number of Telegram Stars that can be claimed by the receiver instead of the regular gift; 0 if the gift can&#x27;t be sold by the current user.

Definition at line 58558 of file td_api.h.

◆ sender_id_

object_ptr<MessageSender> td::td_api::receivedGift::sender_id_

Identifier of a user or a chat that sent the gift; may be null if unknown.

Definition at line 58534 of file td_api.h.

◆ text_

object_ptr<formattedText> td::td_api::receivedGift::text_

Message added to the gift.

Definition at line 58536 of file td_api.h.

◆ transfer_star_count_

int53 td::td_api::receivedGift::transfer_star_count_

Number of Telegram Stars that must be paid to transfer the upgraded gift; only for the receiver of the gift.

Definition at line 58564 of file td_api.h.

◆ unique_gift_number_

int32 td::td_api::receivedGift::unique_gift_number_

Unique number of the gift among gifts upgraded from the same gift after upgrade; 0 if yet unassigned.

Definition at line 58538 of file td_api.h.

◆ was_refunded_

bool td::td_api::receivedGift::was_refunded_

True, if the gift was refunded and isn&#x27;t available anymore.

Definition at line 58550 of file td_api.h.


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