TDLib
Loading...
Searching...
No Matches
starGiveawayPaymentOption Class Referencefinal

Inherits Object.

Description

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

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 TlObject
TlObject & operator= (const TlObject &)=delete
TlObject & operator= (TlObject &&)=default
virtual void store (TlStorerCalcLength &s) const
virtual void store (TlStorerUnsafe &s) const
 TlObject ()=default
 TlObject (const TlObject &)=delete
 TlObject (TlObject &&)=default
virtual ~TlObject ()=default

Public Attributes

int53 amount_
 The amount to pay, in the smallest units of the currency.
string currency_
 ISO 4217 currency code for the payment.
bool is_additional_
 True, if the option must be shown only in the full list of payment options.
bool is_default_
 True, if the option must be chosen by default.
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.
array< object_ptr< starGiveawayWinnerOption > > winner_options_
 Allowed options for the number of giveaway winners.
int32 yearly_boost_count_
 Number of times the chat will be boosted for one year if the option is chosen.

Static Public Attributes

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

Constructor & Destructor Documentation

◆ starGiveawayPaymentOption() [1/2]

starGiveawayPaymentOption ( )

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

◆ starGiveawayPaymentOption() [2/2]

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