Message.edit_caption()¶

Message.edit_caption()¶

Bound method edit_caption of Message.

Use as a shortcut for:

await client.edit_message_caption(
    chat_id=message.chat.id,
    message_id=message.id,
    caption="hello"
)

Example

await message.edit_caption("hello")

Parameters:¶

• caption (``str``) – New caption of the message.

• parse_mode (:obj:`~pyrogram.enums.ParseMode`, *optional*) – By default, texts are parsed using both Markdown and HTML styles. You can combine both syntaxes together.

• caption_entities (List of :obj:`~pyrogram.types.MessageEntity`) – List of special entities that appear in the caption, which can be specified instead of parse_mode.

• reply_markup (:obj:`~pyrogram.types.InlineKeyboardMarkup`, *optional*) – An InlineKeyboardMarkup object.

Returns:¶

On success, the edited Message is returned.

Raises:¶

RPCError –