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::giftPremiumWithStars Class Referencefinal

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

Inheritance diagram for td::td_api::giftPremiumWithStars:
td::td_api::Function td::TlObject

Public Types

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

Public Member Functions

 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 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

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, CustomEmoji, and DateTime entities are allowed.
 

Static Public Attributes

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

Detailed Description

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

Returns object_ptr<Ok>.

Definition at line 115931 of file td_api.h.

Member Typedef Documentation

◆ ReturnType

Typedef for the type returned by the function.

Definition at line 115973 of file td_api.h.

Constructor & Destructor Documentation

◆ giftPremiumWithStars() [1/2]

td::td_api::giftPremiumWithStars::giftPremiumWithStars ( )

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]

td::td_api::giftPremiumWithStars::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, CustomEmoji, and DateTime entities are allowed.

Member Function Documentation

◆ store()

void td::td_api::giftPremiumWithStars::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

◆ ID

const std::int32_t td::td_api::giftPremiumWithStars::ID = -2058395432
static

Identifier uniquely determining a type of the object.

Definition at line 115970 of file td_api.h.

◆ month_count_

int32 td::td_api::giftPremiumWithStars::month_count_

Number of months the Telegram Premium subscription will be active for the user.

Definition at line 115946 of file td_api.h.

◆ star_count_

int53 td::td_api::giftPremiumWithStars::star_count_

The number of Telegram Stars to pay for subscription.

Definition at line 115944 of file td_api.h.

◆ text_

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

Text to show to the user receiving Telegram Premium; 0-getOption("gift_text_length_max") characters. Only Bold, Italic, Underline, Strikethrough, Spoiler, CustomEmoji, and DateTime entities are allowed.

Definition at line 115948 of file td_api.h.

◆ user_id_

int53 td::td_api::giftPremiumWithStars::user_id_

Identifier of the user which will receive Telegram Premium.

Definition at line 115942 of file td_api.h.


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