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

Inherits Function.

Description

Allows to buy a Telegram Premium subscription for another user with payment in Telegram Stars; for bots only.

Returns object_ptr<Ok>.

Public Fields

int53 user_id_
 Identifier of the user which will receive Telegram Premium.
 
int53 star_count_
 The number of Telegram Stars to pay for subscription.
 
int32 month_count_
 Number of months the Telegram Premium subscription will be active for the user.
 
object_ptr< formattedTexttext_
 Text to show to the user receiving Telegram Premium; 0-getOption("gift_text_length_max") characters. Only Bold, Italic, Underline, Strikethrough, Spoiler, and CustomEmoji entities are allowed.
 

Public Types

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

Public Instance Methods

 giftPremiumWithStars ()
 
 giftPremiumWithStars (int53 user_id_, int53 star_count_, int32 month_count_, object_ptr< formattedText > &&text_)
 
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 = -2058395432
 Identifier uniquely determining a type of the object.
 

Constructor & Destructor Documentation

◆ giftPremiumWithStars() [1/2]

Default constructor for a function, which allows to buy a Telegram Premium subscription for another user with payment in Telegram Stars; for bots only.

Returns object_ptr<Ok>.

◆ giftPremiumWithStars() [2/2]

giftPremiumWithStars ( int53  user_id_,
int53  star_count_,
int32  month_count_,
object_ptr< formattedText > &&  text_ 
)

Creates a function, which allows to buy a Telegram Premium subscription for another user with payment in Telegram Stars; for bots only.

Returns object_ptr<Ok>.

Parameters
[in]user_id_Identifier of the user which will receive Telegram Premium.
[in]star_count_The number of Telegram Stars to pay for subscription.
[in]month_count_Number of months the Telegram Premium subscription will be active for the user.
[in]text_Text to show to the user receiving Telegram Premium; 0-getOption("gift_text_length_max") characters. Only Bold, Italic, Underline, Strikethrough, Spoiler, and CustomEmoji entities are allowed.

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: