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

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

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

Public Member Functions

 starGiveawayPaymentOption ()
 
 starGiveawayPaymentOption (string const &currency_, int53 amount_, int53 star_count_, string const &store_product_id_, int32 yearly_boost_count_, array< object_ptr< starGiveawayWinnerOption > > &&winner_options_, bool is_default_, bool is_additional_)
 
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 currency_
 ISO 4217 currency code for the payment.
 
int53 amount_
 The amount to pay, in the smallest units of the currency.
 
int53 star_count_
 Number of Telegram Stars that will be distributed among winners.
 
string store_product_id_
 Identifier of the store product associated with the option; may be empty if none.
 
int32 yearly_boost_count_
 Number of times the chat will be boosted for one year if the option is chosen.
 
array< object_ptr< starGiveawayWinnerOption > > winner_options_
 Allowed options for the number of giveaway winners.
 
bool is_default_
 True, if the option must be chosen by default.
 
bool is_additional_
 True, if the option must be shown only in the full list of payment options.
 

Static Public Attributes

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

Detailed Description

Describes an option for creating of Telegram Star giveaway. Use telegramPaymentPurposeStarGiveaway for out-of-store payments.

Definition at line 64367 of file td_api.h.

Constructor & Destructor Documentation

◆ starGiveawayPaymentOption() [1/2]

td::td_api::starGiveawayPaymentOption::starGiveawayPaymentOption ( )

Describes an option for creating of Telegram Star giveaway. Use telegramPaymentPurposeStarGiveaway for out-of-store payments.

◆ starGiveawayPaymentOption() [2/2]

td::td_api::starGiveawayPaymentOption::starGiveawayPaymentOption ( string const &  currency_,
int53  amount_,
int53  star_count_,
string const &  store_product_id_,
int32  yearly_boost_count_,
array< object_ptr< starGiveawayWinnerOption > > &&  winner_options_,
bool  is_default_,
bool  is_additional_ 
)

Describes an option for creating of Telegram Star giveaway. Use telegramPaymentPurposeStarGiveaway for out-of-store payments.

Parameters
[in]currency_ISO 4217 currency code for the payment.
[in]amount_The amount to pay, in the smallest units of the currency.
[in]star_count_Number of Telegram Stars that will be distributed among winners.
[in]store_product_id_Identifier of the store product associated with the option; may be empty if none.
[in]yearly_boost_count_Number of times the chat will be boosted for one year if the option is chosen.
[in]winner_options_Allowed options for the number of giveaway winners.
[in]is_default_True, if the option must be chosen by default.
[in]is_additional_True, if the option must be shown only in the full list of payment options.

Member Function Documentation

◆ store()

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

◆ amount_

int53 td::td_api::starGiveawayPaymentOption::amount_

The amount to pay, in the smallest units of the currency.

Definition at line 64380 of file td_api.h.

◆ currency_

string td::td_api::starGiveawayPaymentOption::currency_

ISO 4217 currency code for the payment.

Definition at line 64378 of file td_api.h.

◆ ID

const std::int32_t td::td_api::starGiveawayPaymentOption::ID = 565089625
static

Identifier uniquely determining a type of the object.

Definition at line 64414 of file td_api.h.

◆ is_additional_

bool td::td_api::starGiveawayPaymentOption::is_additional_

True, if the option must be shown only in the full list of payment options.

Definition at line 64392 of file td_api.h.

◆ is_default_

bool td::td_api::starGiveawayPaymentOption::is_default_

True, if the option must be chosen by default.

Definition at line 64390 of file td_api.h.

◆ star_count_

int53 td::td_api::starGiveawayPaymentOption::star_count_

Number of Telegram Stars that will be distributed among winners.

Definition at line 64382 of file td_api.h.

◆ store_product_id_

string td::td_api::starGiveawayPaymentOption::store_product_id_

Identifier of the store product associated with the option; may be empty if none.

Definition at line 64384 of file td_api.h.

◆ winner_options_

array<object_ptr<starGiveawayWinnerOption> > td::td_api::starGiveawayPaymentOption::winner_options_

Allowed options for the number of giveaway winners.

Definition at line 64388 of file td_api.h.

◆ yearly_boost_count_

int32 td::td_api::starGiveawayPaymentOption::yearly_boost_count_

Number of times the chat will be boosted for one year if the option is chosen.

Definition at line 64386 of file td_api.h.


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