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

GiveawayWinners

@Serializable

data class GiveawayWinners(val chat: Chat, val giveawayMessageId: Long, val winnersSelectionDate: Instant, val winnerCount: Int, val winners: List<User>, val additionalChatCount: Int? = null, val prizeStarCount: Int? = null, val premiumSubscriptionMonthCount: Int? = null, val unclaimedPrizeCount: Int? = null, val onlyNewMembers: Boolean? = null, val wasRefunded: Boolean? = null, val prizeDescription: String? = null)

This object represents a message about the completion of a giveaway with public winners.

Constructors

GiveawayWinners

constructor(chat: Chat, giveawayMessageId: Long, winnersSelectionDate: Instant, winnerCount: Int, winners: List<User>, additionalChatCount: Int? = null, prizeStarCount: Int? = null, premiumSubscriptionMonthCount: Int? = null, unclaimedPrizeCount: Int? = null, onlyNewMembers: Boolean? = null, wasRefunded: Boolean? = null, prizeDescription: String? = null)

Properties

additionalChatCount

val additionalChatCount: Int? = null

Optional. The number of other chats the user had to join in order to be eligible for the giveaway

The chat that created the giveaway

giveawayMessageId

val giveawayMessageId: Long

Identifier of the message with the giveaway in the chat

val onlyNewMembers: Boolean? = null

Optional. True, if only users who had joined the chats after the giveaway started were eligible to win

premiumSubscriptionMonthCount

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

prizeDescription

val prizeDescription: String? = null

Optional. Description of additional giveaway prize

val prizeStarCount: Int? = null

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

unclaimedPrizeCount

val unclaimedPrizeCount: Int? = null

Optional. Number of undistributed prizes

val wasRefunded: Boolean? = null

Optional. True, if the giveaway was canceled because the payment for it was refunded

val winnerCount: Int

Total number of winners in the giveaway

val winners: List<User>

List of up to 100 winners of the giveaway

winnersSelectionDate

@Serializable(with = InstantSerializer::class)

val winnersSelectionDate: Instant

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