List of all members | Public Fields | Public Instance Methods | Static Public Attributes
userGift Class Referencefinal

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< formattedTexttext_
 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; may be false only for the receiver of the gift.
 
int32 date_
 Point in time (Unix timestamp) when the gift was sent.
 
object_ptr< giftgift_
 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 gift receiver.
 
int53 sell_star_count_
 Number of Telegram Stars that can be claimed by the receiver instead of the gift; only for the gift receiver.
 

Public Instance Methods

 userGift ()
 
 userGift (int53 sender_user_id_, object_ptr< formattedText > &&text_, bool is_private_, bool is_saved_, int32 date_, object_ptr< gift > &&gift_, int53 message_id_, int53 sell_star_count_)
 
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
 
TlObjectoperator= (const TlObject &)=delete
 
 TlObject (TlObject &&)=default
 
TlObjectoperator= (TlObject &&)=default
 
virtual ~TlObject ()=default
 

Static Public Attributes

static const std::int32_t ID = 1229895457
 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_,
int32  date_,
object_ptr< gift > &&  gift_,
int53  message_id_,
int53  sell_star_count_ 
)

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; may be false only for the receiver of the gift.
[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 gift receiver.
[in]sell_star_count_Number of Telegram Stars that can be claimed by the receiver instead of the gift; only for the gift receiver.

Method Documentation

◆ store()

void 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 TlObject.


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