mirror of
https://github.com/aiogram/aiogram.git
synced 2026-04-08 16:37:47 +00:00
70dd8b8b3c
The thumbnail's type restriction has been changed in several methods and types. Previously, it accepted Union[InputFile, str], allowing both InputFile instances and strings. Now it's changed to accept only InputFile instances. This change enhances meaning of the thumbnail fields in due to Bot API accepts only InputFile instances.
101 lines
5.6 KiB
Python
101 lines
5.6 KiB
Python
from __future__ import annotations
|
|
|
|
from typing import TYPE_CHECKING, Any, List, Optional, Union
|
|
|
|
from ..types import (
|
|
UNSET_PARSE_MODE,
|
|
ForceReply,
|
|
InlineKeyboardMarkup,
|
|
InputFile,
|
|
Message,
|
|
MessageEntity,
|
|
ReplyKeyboardMarkup,
|
|
ReplyKeyboardRemove,
|
|
)
|
|
from ..types.base import UNSET_PROTECT_CONTENT
|
|
from .base import TelegramMethod
|
|
|
|
|
|
class SendDocument(TelegramMethod[Message]):
|
|
"""
|
|
Use this method to send general files. On success, the sent :class:`aiogram.types.message.Message` is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.
|
|
|
|
Source: https://core.telegram.org/bots/api#senddocument
|
|
"""
|
|
|
|
__returning__ = Message
|
|
__api_method__ = "sendDocument"
|
|
|
|
chat_id: Union[int, str]
|
|
"""Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)"""
|
|
document: Union[InputFile, str]
|
|
"""File to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. :ref:`More information on Sending Files » <sending-files>`"""
|
|
message_thread_id: Optional[int] = None
|
|
"""Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"""
|
|
thumbnail: Optional[InputFile] = None
|
|
"""Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass 'attach://<file_attach_name>' if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. :ref:`More information on Sending Files » <sending-files>`"""
|
|
caption: Optional[str] = None
|
|
"""Document caption (may also be used when resending documents by *file_id*), 0-1024 characters after entities parsing"""
|
|
parse_mode: Optional[str] = UNSET_PARSE_MODE
|
|
"""Mode for parsing entities in the document caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details."""
|
|
caption_entities: Optional[List[MessageEntity]] = None
|
|
"""A JSON-serialized list of special entities that appear in the caption, which can be specified instead of *parse_mode*"""
|
|
disable_content_type_detection: Optional[bool] = None
|
|
"""Disables automatic server-side content type detection for files uploaded using multipart/form-data"""
|
|
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."""
|
|
|
|
if TYPE_CHECKING:
|
|
# DO NOT EDIT MANUALLY!!!
|
|
# This section was auto-generated via `butcher`
|
|
|
|
def __init__(
|
|
__pydantic__self__,
|
|
*,
|
|
chat_id: Union[int, str],
|
|
document: Union[InputFile, str],
|
|
message_thread_id: Optional[int] = None,
|
|
thumbnail: Optional[InputFile] = None,
|
|
caption: Optional[str] = None,
|
|
parse_mode: Optional[str] = UNSET_PARSE_MODE,
|
|
caption_entities: Optional[List[MessageEntity]] = None,
|
|
disable_content_type_detection: Optional[bool] = None,
|
|
disable_notification: Optional[bool] = None,
|
|
protect_content: Optional[bool] = UNSET_PROTECT_CONTENT,
|
|
reply_to_message_id: Optional[int] = None,
|
|
allow_sending_without_reply: Optional[bool] = None,
|
|
reply_markup: Optional[
|
|
Union[InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove, ForceReply]
|
|
] = None,
|
|
**__pydantic_kwargs: Any,
|
|
) -> None:
|
|
# DO NOT EDIT MANUALLY!!!
|
|
# This method was auto-generated via `butcher`
|
|
# Is needed only for type checking and IDE support without any additional plugins
|
|
|
|
super().__init__(
|
|
chat_id=chat_id,
|
|
document=document,
|
|
message_thread_id=message_thread_id,
|
|
thumbnail=thumbnail,
|
|
caption=caption,
|
|
parse_mode=parse_mode,
|
|
caption_entities=caption_entities,
|
|
disable_content_type_detection=disable_content_type_detection,
|
|
disable_notification=disable_notification,
|
|
protect_content=protect_content,
|
|
reply_to_message_id=reply_to_message_id,
|
|
allow_sending_without_reply=allow_sending_without_reply,
|
|
reply_markup=reply_markup,
|
|
**__pydantic_kwargs,
|
|
)
|