mirror of
https://github.com/aiogram/aiogram.git
synced 2026-04-08 16:37:47 +00:00
46 lines
1.9 KiB
Python
46 lines
1.9 KiB
Python
from __future__ import annotations
|
|
|
|
from typing import TYPE_CHECKING, Any, Dict, List, Optional, Union
|
|
|
|
from ..types import UNSET, InlineKeyboardMarkup, Message, MessageEntity
|
|
from .base import Request, TelegramMethod, prepare_parse_mode
|
|
|
|
if TYPE_CHECKING: # pragma: no cover
|
|
from ..client.bot import Bot
|
|
|
|
|
|
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 Message is returned, otherwise True is returned.
|
|
|
|
Source: https://core.telegram.org/bots/api#editmessagecaption
|
|
"""
|
|
|
|
__returning__ = Union[Message, bool]
|
|
|
|
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 @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] = UNSET
|
|
"""Mode for parsing entities in the message caption. See formatting options for more details."""
|
|
caption_entities: Optional[List[MessageEntity]] = None
|
|
"""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."""
|
|
|
|
def build_request(self, bot: Bot) -> Request:
|
|
data: Dict[str, Any] = self.dict()
|
|
|
|
prepare_parse_mode(
|
|
bot, data, parse_mode_property="parse_mode", entities_property="caption_entities"
|
|
)
|
|
|
|
return Request(method="editMessageCaption", data=data)
|