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

Inherits Function.

Description

Places a bid on an auction gift.

Returns object_ptr<Ok>.

Public Fields

int64 gift_id_
 Identifier of the gift to place the bid on.
 
int53 star_count_
 The number of Telegram Stars to place in the bid.
 
int53 user_id_
 Identifier of the user who will receive the gift.
 
object_ptr< formattedTexttext_
 Text to show along with the gift; 0-getOption("gift_text_length_max") characters. Only Bold, Italic, Underline, Strikethrough, Spoiler, and CustomEmoji entities are allowed. Must be empty if the receiver enabled paid messages.
 
bool is_private_
 Pass true to show gift text and sender only to the gift receiver; otherwise, everyone will be able to see them.
 

Public Types

using ReturnType = object_ptr< ok >
 Typedef for the type returned by the function.
 

Public Instance Methods

 placeGiftAuctionBid ()
 
 placeGiftAuctionBid (int64 gift_id_, int53 star_count_, int53 user_id_, object_ptr< formattedText > &&text_, bool is_private_)
 
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 = 1437176980
 Identifier uniquely determining a type of the object.
 

Constructor & Destructor Documentation

◆ placeGiftAuctionBid() [1/2]

Default constructor for a function, which places a bid on an auction gift.

Returns object_ptr<Ok>.

◆ placeGiftAuctionBid() [2/2]

placeGiftAuctionBid ( int64  gift_id_,
int53  star_count_,
int53  user_id_,
object_ptr< formattedText > &&  text_,
bool  is_private_ 
)

Creates a function, which places a bid on an auction gift.

Returns object_ptr<Ok>.

Parameters
[in]gift_id_Identifier of the gift to place the bid on.
[in]star_count_The number of Telegram Stars to place in the bid.
[in]user_id_Identifier of the user who will receive the gift.
[in]text_Text to show along with the gift; 0-getOption("gift_text_length_max") characters. Only Bold, Italic, Underline, Strikethrough, Spoiler, and CustomEmoji entities are allowed. Must be empty if the receiver enabled paid messages.
[in]is_private_Pass true to show gift text and sender only to the gift receiver; otherwise, everyone will be able to see them.

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: