peyk.platforms.telegram.types.giveaway

Classes

Giveaway(chats, winners_selection_date, ...)

This object represents a message about a scheduled giveaway.
class peyk.platforms.telegram.types.giveaway.Giveaway(chats: List[Chat], winners_selection_date: int, winner_count: int, only_new_members: bool | None = None, has_public_winners: bool | None = None, prize_description: str | None = None, country_codes: List[str] | None = None, prize_star_count: int | None = None, premium_subscription_month_count: int | None = None)[source]

Bases: object

This object represents a message about a scheduled giveaway.

Variables:

  • chats (List[peyk.platforms.telegram.types.chat.Chat]) – The list of chats which the user must join to participate in the giveaway

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

  • winner_count (int) – The number of users which are supposed to be selected as winners of the giveaway

  • only_new_members (bool | None) – True, if only users who join the chats after the giveaway started should be eligible to win

  • has_public_winners (bool | None) – True, if the list of giveaway winners will be visible to everyone

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

  • country_codes (List[str] | None) – 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.

  • prize_star_count (int | None) – The number of Telegram Stars to be 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

chats: List[Chat]
winners_selection_date: int
winner_count: int
only_new_members: bool | None = None
has_public_winners: bool | None = None
prize_description: str | None = None
country_codes: List[str] | None = None
prize_star_count: int | None = None
premium_subscription_month_count: int | None = None
classmethod from_dict(data: dict | None) → Giveaway | None[source]

Provides the from dict operation for the Telegram integration.

Parameters:

data – Value used by this operation.

Returns:

Result produced by the operation.