StarsGiveawayOption

class pyrogram.raw.types.StarsGiveawayOption

Contains info about a Telegram Star giveaway option.

Constructor of StarsGiveawayOption.

Details:

• Layer: 223

• ID: 94CE852A

Parameters:

• stars (int 64-bit) – The number of Telegram Stars that will be distributed among winners

• yearly_boosts (int 32-bit) – Number of times the chat will be boosted for one year if the inputStorePaymentStarsGiveaway.boost_peer flag is populated

• currency (str) – Three-letter ISO 4217 currency code

• amount (int 64-bit) – Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).

• winners (List of StarsGiveawayWinnersOption) – Allowed options for the number of giveaway winners.

• extended (bool, optional) – If set, this option must only be shown in the full list of giveaway options (i.e. they must be added to the list only when the user clicks on the expand button).

• default (bool, optional) – If set, this option must be pre-selected by default in the option list.

• store_product (str, optional) – Identifier of the store product associated with the option, official apps only.

Functions:

This object can be returned by 1 function.

payments.GetStarsGiveawayOptions

Fetch a list of star giveaway options ».

TL Schema

starsGiveawayOption#94ce852a
flags:#
extended:flags.0?true
default:flags.1?true
stars:long
yearly_boosts:int
store_product:flags.2?string
currency:string
amount:long
winners:Vector<StarsGiveawayWinnersOption>

= StarsGiveawayOption

Parameter Tree

Example

StarsGiveawayOption(
    stars=0,
    yearly_boosts=0,
    currency="text",
    amount=0,
    winners=[
            StarsGiveawayWinnersOption(
                users=0,
                per_user_stars=0
            )
        ],
)