mirror of
https://github.com/aiogram/aiogram.git
synced 2026-04-08 16:37:47 +00:00
4008a3114d
Upgrade architecture + 5.0 Bot API (#469) * Moved `methods`, `types` and `client` to root package * Removed update handler from routers to dispatcher * Reworked events propagation mechanism to handlers * Reworked inner middlewares logic (very small change) * Updated to Bot API 5.0 * Initial migration from MkDocs to Sphinx + config for readthedocs
45 lines
1.8 KiB
Python
45 lines
1.8 KiB
Python
from __future__ import annotations
|
|
|
|
import datetime
|
|
from typing import TYPE_CHECKING, List, Optional, Union
|
|
|
|
from .base import TelegramObject
|
|
|
|
if TYPE_CHECKING: # pragma: no cover
|
|
from .message_entity import MessageEntity
|
|
from .poll_option import PollOption
|
|
|
|
|
|
class Poll(TelegramObject):
|
|
"""
|
|
This object contains information about a poll.
|
|
|
|
Source: https://core.telegram.org/bots/api#poll
|
|
"""
|
|
|
|
id: str
|
|
"""Unique poll identifier"""
|
|
question: str
|
|
"""Poll question, 1-300 characters"""
|
|
options: List[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"""
|
|
correct_option_id: Optional[int] = None
|
|
"""*Optional*. 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."""
|
|
explanation: Optional[str] = None
|
|
"""*Optional*. 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: Optional[List[MessageEntity]] = None
|
|
"""*Optional*. Special entities like usernames, URLs, bot commands, etc. that appear in the *explanation*"""
|
|
open_period: Optional[int] = None
|
|
"""*Optional*. Amount of time in seconds the poll will be active after creation"""
|
|
close_date: Optional[Union[datetime.datetime, datetime.timedelta, int]] = None
|
|
"""*Optional*. Point in time (Unix timestamp) when the poll will be automatically closed"""
|