mirror of
https://github.com/aiogram/aiogram.git
synced 2026-04-08 16:37:47 +00:00
34 lines
1.8 KiB
Python
34 lines
1.8 KiB
Python
from __future__ import annotations
|
|
|
|
from typing import TYPE_CHECKING, List, Optional, Union
|
|
|
|
import msgspec
|
|
|
|
from ..types import UNSET_PARSE_MODE, InlineKeyboardMarkup, Message, MessageEntity
|
|
from .base import TelegramMethod
|
|
|
|
|
|
class EditMessageCaption(TelegramMethod[Union[Message, bool]]):
|
|
"""
|
|
Use this method to edit captions of messages. On success, if the edited message is not an inline message, the edited :class:`aiogram.types.message.Message` is returned, otherwise :code:`True` is returned.
|
|
|
|
Source: https://core.telegram.org/bots/api#editmessagecaption
|
|
"""
|
|
|
|
__returning__ = Union[Message, bool]
|
|
__api_method__ = "editMessageCaption"
|
|
|
|
chat_id: Optional[Union[int, str]] = None
|
|
"""Required if *inline_message_id* is not specified. Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)"""
|
|
message_id: Optional[int] = None
|
|
"""Required if *inline_message_id* is not specified. Identifier of the message to edit"""
|
|
inline_message_id: Optional[str] = None
|
|
"""Required if *chat_id* and *message_id* are not specified. Identifier of the inline message"""
|
|
caption: Optional[str] = None
|
|
"""New caption of the message, 0-1024 characters after entities parsing"""
|
|
parse_mode: Optional[str] = msgspec.field(default_factory=lambda: UNSET_PARSE_MODE)
|
|
"""Mode for parsing entities in the message 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*"""
|
|
reply_markup: Optional[InlineKeyboardMarkup] = None
|
|
"""A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_."""
|