mirror of
https://github.com/aiogram/aiogram.git
synced 2026-04-08 16:37:47 +00:00
7776cf9cf6
* Update API, added some new features * Fixed unknown chat_action value * Separate events from dispatcher messages * Disabled cache for I18n LazyProxy * Rework events isolation * Added chat member status changed filter, update Bot API 5.7, other small changes * Improve exceptions in chat member status filter * Fixed tests, covered flags and events isolation modules * Try to fix flake8 unused type ignore * Fixed linter error * Cover chat member updated filter * Cover chat action sender * Added docs for chat action util * Try to fix tests for python <= 3.9 * Fixed headers * Added docs for flags functionality * Added docs for chat_member_updated filter * Added change notes * Update dependencies and fix mypy checks * Bump version
79 lines
4 KiB
Python
79 lines
4 KiB
Python
from __future__ import annotations
|
|
|
|
import datetime
|
|
from typing import TYPE_CHECKING, Any, Dict, List, Optional, Union
|
|
|
|
from ..types import (
|
|
UNSET,
|
|
ForceReply,
|
|
InlineKeyboardMarkup,
|
|
Message,
|
|
MessageEntity,
|
|
ReplyKeyboardMarkup,
|
|
ReplyKeyboardRemove,
|
|
)
|
|
from .base import Request, TelegramMethod, prepare_parse_mode
|
|
|
|
if TYPE_CHECKING:
|
|
from ..client.bot import Bot
|
|
|
|
|
|
class SendPoll(TelegramMethod[Message]):
|
|
"""
|
|
Use this method to send a native poll. On success, the sent :class:`aiogram.types.message.Message` is returned.
|
|
|
|
Source: https://core.telegram.org/bots/api#sendpoll
|
|
"""
|
|
|
|
__returning__ = Message
|
|
|
|
chat_id: Union[int, str]
|
|
"""Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)"""
|
|
question: str
|
|
"""Poll question, 1-300 characters"""
|
|
options: List[str]
|
|
"""A JSON-serialized list of answer options, 2-10 strings 1-100 characters each"""
|
|
is_anonymous: Optional[bool] = None
|
|
""":code:`True`, if the poll needs to be anonymous, defaults to :code:`True`"""
|
|
type: Optional[str] = None
|
|
"""Poll type, 'quiz' or 'regular', defaults to 'regular'"""
|
|
allows_multiple_answers: Optional[bool] = None
|
|
""":code:`True`, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to :code:`False`"""
|
|
correct_option_id: Optional[int] = None
|
|
"""0-based identifier of the correct answer option, required for polls in quiz mode"""
|
|
explanation: Optional[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 with at most 2 line feeds after entities parsing"""
|
|
explanation_parse_mode: Optional[str] = UNSET
|
|
"""Mode for parsing entities in the explanation. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details."""
|
|
explanation_entities: Optional[List[MessageEntity]] = None
|
|
"""A JSON-serialized list of special entities that appear in the poll explanation, which can be specified instead of *parse_mode*"""
|
|
open_period: Optional[int] = None
|
|
"""Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with *close_date*."""
|
|
close_date: Optional[Union[datetime.datetime, datetime.timedelta, int]] = None
|
|
"""Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 600 seconds in the future. Can't be used together with *open_period*."""
|
|
is_closed: Optional[bool] = None
|
|
"""Pass :code:`True`, if the poll needs to be immediately closed. This can be useful for poll preview."""
|
|
disable_notification: Optional[bool] = None
|
|
"""Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound."""
|
|
protect_content: Optional[bool] = None
|
|
"""Protects the contents of the sent message from forwarding and saving"""
|
|
reply_to_message_id: Optional[int] = None
|
|
"""If the message is a reply, ID of the original message"""
|
|
allow_sending_without_reply: Optional[bool] = None
|
|
"""Pass :code:`True`, if the message should be sent even if the specified replied-to message is not found"""
|
|
reply_markup: Optional[
|
|
Union[InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove, ForceReply]
|
|
] = None
|
|
"""Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating>`_, `custom reply keyboard <https://core.telegram.org/bots#keyboards>`_, instructions to remove reply keyboard or to force a reply from the user."""
|
|
|
|
def build_request(self, bot: Bot) -> Request:
|
|
data: Dict[str, Any] = self.dict()
|
|
|
|
prepare_parse_mode(
|
|
bot,
|
|
data,
|
|
parse_mode_property="explanation_parse_mode",
|
|
entities_property="explanation_entities",
|
|
)
|
|
|
|
return Request(method="sendPoll", data=data)
|