mirror of
https://github.com/aiogram/aiogram.git
synced 2026-04-08 16:37:47 +00:00
fea1b7b0a3
* Reworked request builder * Added more default values * Update tests * Fixed timestamp * Fixed Py3.8 support * Describe changes
51 lines
2.6 KiB
Python
51 lines
2.6 KiB
Python
from __future__ import annotations
|
|
|
|
from typing import TYPE_CHECKING, List, Optional, Union
|
|
|
|
from ..types import (
|
|
UNSET_PARSE_MODE,
|
|
ForceReply,
|
|
InlineKeyboardMarkup,
|
|
Message,
|
|
MessageEntity,
|
|
ReplyKeyboardMarkup,
|
|
ReplyKeyboardRemove,
|
|
)
|
|
from ..types.base import UNSET_DISABLE_WEB_PAGE_PREVIEW, UNSET_PROTECT_CONTENT
|
|
from .base import TelegramMethod
|
|
|
|
|
|
class SendMessage(TelegramMethod[Message]):
|
|
"""
|
|
Use this method to send text messages. On success, the sent :class:`aiogram.types.message.Message` is returned.
|
|
|
|
Source: https://core.telegram.org/bots/api#sendmessage
|
|
"""
|
|
|
|
__returning__ = Message
|
|
__api_method__ = "sendMessage"
|
|
|
|
chat_id: Union[int, str]
|
|
"""Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)"""
|
|
text: str
|
|
"""Text of the message to be sent, 1-4096 characters after entities parsing"""
|
|
message_thread_id: Optional[int] = None
|
|
"""Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"""
|
|
parse_mode: Optional[str] = UNSET_PARSE_MODE
|
|
"""Mode for parsing entities in the message text. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details."""
|
|
entities: Optional[List[MessageEntity]] = None
|
|
"""A JSON-serialized list of special entities that appear in message text, which can be specified instead of *parse_mode*"""
|
|
disable_web_page_preview: Optional[bool] = UNSET_DISABLE_WEB_PAGE_PREVIEW
|
|
"""Disables link previews for links in this message"""
|
|
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] = UNSET_PROTECT_CONTENT
|
|
"""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/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove reply keyboard or to force a reply from the user."""
|