peyk.platforms.telegram.types.poll

Classes

Poll(id, question, options[, ...])

This object contains information about a poll.
class peyk.platforms.telegram.types.poll.Poll(id: str, question: str, options: List[PollOption], total_voter_count: int = 0, is_closed: bool = False, is_anonymous: bool = True, type: str = 'regular', allows_multiple_answers: bool = False, allows_revoting: bool = False, members_only: bool | None = None, country_codes: List[str] | None = None, question_entities: List[MessageEntity] | None = None, correct_option_ids: List[int] | None = None, explanation: str | None = None, explanation_entities: List[MessageEntity] | None = None, explanation_media: PollMedia | None = None, open_period: int | None = None, close_date: int | None = None, description: str | None = None, description_entities: List[MessageEntity] | None = None, media: PollMedia | None = None)[source]

Bases: object

This object contains information about a poll.

Variables:

  • id (str) – Unique poll identifier

  • question (str) – Poll question, 1-300 characters

  • options (List[peyk.platforms.telegram.types.poll_option.PollOption]) – List of poll options

  • total_voter_count (int) – Total number of users that voted in the poll

  • is_closed (bool) – True, if the poll is closed

  • is_anonymous (bool) – True, if the poll is anonymous

  • type (str) – Poll type, currently can be ‘regular’ or ‘quiz’

  • allows_multiple_answers (bool) – True, if the poll allows multiple answers

  • allows_revoting (bool) – True, if the poll allows to change the chosen answer options

  • members_only (bool | None) – True if voting is limited to users who have been members of the chat where the poll was originally sent for more than 24 hours

  • question_entities (List[peyk.platforms.telegram.types.message_entity.MessageEntity] | None) – Special entities that appear in the question. Currently, only custom emoji entities are allowed in poll questions

  • country_codes (List[str] | None) – A list of two-letter ISO 3166-1 alpha-2 country codes indicating the countries from which users can vote in the poll. The country code ‘FT’ is used for users with anonymous numbers. If omitted, then users from any country can participate in the poll.

  • correct_option_ids (List[int] | None) – Array of 0-based identifiers of the correct answer options. Available only for polls in quiz mode which are closed or were sent (not forwarded) by the bot or to the private chat with the bot.

  • explanation (str | None) – Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters

  • explanation_entities (List[peyk.platforms.telegram.types.message_entity.MessageEntity] | None) – Special entities like usernames, URLs, bot commands, etc. that appear in the explanation

  • explanation_media (peyk.platforms.telegram.types.poll_media.PollMedia | None) – Media added to the quiz explanation

  • open_period (int | None) – Amount of time in seconds the poll will be active after creation

  • close_date (int | None) – Point in time (Unix timestamp) when the poll will be automatically closed

  • description (str | None) – Description of the poll; for polls inside the Message object only

  • description_entities (List[peyk.platforms.telegram.types.message_entity.MessageEntity] | None) – Special entities like usernames, URLs, bot commands, etc. that appear in the description

  • media (peyk.platforms.telegram.types.poll_media.PollMedia | None) – Media added to the poll description; for polls inside the Message object only

  • correct_option_id – 0-based identifier of the correct answer option. Available only for polls in the quiz mode, which are closed, or was sent (not forwarded) by the bot or to the private chat with the bot.

id: str
question: str
options: List[PollOption]
total_voter_count: int = 0
is_closed: bool = False
is_anonymous: bool = True
type: str = 'regular'
allows_multiple_answers: bool = False
allows_revoting: bool = False
members_only: bool | None = None
country_codes: List[str] | None = None
question_entities: List[MessageEntity] | None = None
correct_option_ids: List[int] | None = None
explanation: str | None = None
explanation_entities: List[MessageEntity] | None = None
explanation_media: PollMedia | None = None
open_period: int | None = None
close_date: int | None = None
description: str | None = None
description_entities: List[MessageEntity] | None = None
media: PollMedia | None = None
classmethod from_dict(data: dict | None) → Poll | None[source]

Parse a Telegram API mapping into this type.

Parameters:

data – Raw Telegram API mapping, or None.

Returns:

Parsed type instance, or None when data is None.