Constructor: starsGiveawayOption
Contains info about a Telegram Star giveaway option.
Attributes:
| Name | Type | Required | Description |
|---|---|---|---|
| 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. |
| stars | long | Yes | The number of Telegram Stars that will be distributed among winners |
| yearly_boosts | int | Yes | Number of times the chat will be boosted for one year if the inputStorePaymentStarsGiveaway.boost_peer flag is populated |
| store_product | string | Optional | Identifier of the store product associated with the option, official apps only. |
| currency | string | Yes | Three-letter ISO 4217 currency code |
| amount | long | Yes | 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 | Array of StarsGiveawayWinnersOption | Yes | Allowed options for the number of giveaway winners. |
Type: StarsGiveawayOption
Example:
$starsGiveawayOption = ['_' => 'starsGiveawayOption', 'extended' => Bool, 'default' => Bool, 'stars' => long, 'yearly_boosts' => int, 'store_product' => 'string', 'currency' => 'string', 'amount' => long, 'winners' => [StarsGiveawayWinnersOption, StarsGiveawayWinnersOption]];