peyk.platforms.telegram.types.giveaway_winners

Classes

GiveawayWinners(chat, giveaway_message_id, ...)

This object represents a message about the completion of a giveaway with public winners.
class peyk.platforms.telegram.types.giveaway_winners.GiveawayWinners(chat: Chat, giveaway_message_id: int, winners_selection_date: int, winner_count: int, winners: List[User], additional_chat_count: int | None = None, prize_star_count: int | None = None, premium_subscription_month_count: int | None = None, unclaimed_prize_count: int | None = None, only_new_members: bool | None = None, was_refunded: bool | None = None, prize_description: str | None = None)[source]

Bases: object

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

Variables:

  • chat (peyk.platforms.telegram.types.chat.Chat) – The chat that created the giveaway

  • giveaway_message_id (int) – Identifier of the message with the giveaway in the chat

  • winners_selection_date (int) – Point in time (Unix timestamp) when winners of the giveaway were selected

  • winner_count (int) – Total number of winners in the giveaway

  • winners (List[peyk.platforms.telegram.types.user.User]) – List of up to 100 winners of the giveaway

  • additional_chat_count (int | None) – The number of other chats the user had to join in order to be eligible for the giveaway

  • prize_star_count (int | None) – The number of Telegram Stars that were split between giveaway winners; for Telegram Star giveaways only

  • premium_subscription_month_count (int | None) – The number of months the Telegram Premium subscription won from the giveaway will be active for; for Telegram Premium giveaways only

  • unclaimed_prize_count (int | None) – Number of undistributed prizes

  • only_new_members (bool | None) – True, if only users who had joined the chats after the giveaway started were eligible to win

  • was_refunded (bool | None) – True, if the giveaway was canceled because the payment for it was refunded

  • prize_description (str | None) – Description of additional giveaway prize

chat: Chat
giveaway_message_id: int
winners_selection_date: int
winner_count: int
winners: List[User]
additional_chat_count: int | None = None
prize_star_count: int | None = None
premium_subscription_month_count: int | None = None
unclaimed_prize_count: int | None = None
only_new_members: bool | None = None
was_refunded: bool | None = None
prize_description: str | None = None
classmethod from_dict(data: dict | None) → GiveawayWinners | None[source]

Provides the from dict operation for the Telegram integration.

Parameters:

data – Value used by this operation.

Returns:

Result produced by the operation.