Telegram Bot/eu.vendeli.tgbot.types.giveaway/Giveaway

Giveaway

@Serializable
data class Giveaway(val chats: List<Chat>, val winnersSelectionDate: Instant, val winnerCount: Int, val onlyNewMembers: Boolean? = null, val hasPublicWinners: Boolean? = null, val prizeDescription: String? = null, val countryCodes: List<String>? = null, val prizeStarCount: Int? = null, val premiumSubscriptionMonthCount: Int? = null)

This object represents a message about a scheduled giveaway.

Api reference

Constructors

Link copied to clipboard
constructor(chats: List<Chat>, winnersSelectionDate: Instant, winnerCount: Int, onlyNewMembers: Boolean? = null, hasPublicWinners: Boolean? = null, prizeDescription: String? = null, countryCodes: List<String>? = null, prizeStarCount: Int? = null, premiumSubscriptionMonthCount: Int? = null)

Properties

Link copied to clipboard
val chats: List<Chat>

The list of chats which the user must join to participate in the giveaway

Link copied to clipboard
val countryCodes: List<String>? = null

Optional. A list of two-letter ISO 3166-1 alpha-2 country codes indicating the countries from which eligible users for the giveaway must come. If empty, then all users can participate in the giveaway. Users with a phone number that was bought on Fragment can always participate in giveaways.

Link copied to clipboard
val hasPublicWinners: Boolean? = null

Optional. True, if the list of giveaway winners will be visible to everyone

Link copied to clipboard
val onlyNewMembers: Boolean? = null

Optional. True, if only users who join the chats after the giveaway started should be eligible to win

Link copied to clipboard
val premiumSubscriptionMonthCount: Int? = null

Optional. The number of months the Telegram Premium subscription won from the giveaway will be active for; for Telegram Premium giveaways only

Link copied to clipboard
val prizeDescription: String? = null

Optional. Description of additional giveaway prize

Link copied to clipboard
val prizeStarCount: Int? = null

Optional. The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only

Link copied to clipboard
val winnerCount: Int

The number of users which are supposed to be selected as winners of the giveaway

Link copied to clipboard
@Serializable(with = InstantSerializer::class)
val winnersSelectionDate: Instant

Point in time (Unix timestamp) when winners of the giveaway will be selected