# Pyrogram - Telegram MTProto API Client Library for Python
# Copyright (C) 2017-present Dan <https://github.com/delivrance>
#
# This file is part of Pyrogram.
#
# Pyrogram is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published
# by the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Pyrogram is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with Pyrogram. If not, see <http://www.gnu.org/licenses/>.
from __future__ import annotations
import pyrogram
from pyrogram import enums, types
from typing import TYPE_CHECKING
if TYPE_CHECKING:
from datetime import datetime, timedelta
class EditMessageCaption:
async def edit_message_caption(
self: pyrogram.Client,
chat_id: int | str,
message_id: int,
caption: str,
parse_mode: enums.ParseMode | None = None,
caption_entities: list[types.MessageEntity] | None = None,
rich_text: str | types.InputRichMessage | None = None,
rich_text_parse_mode: enums.ParseMode = enums.ParseMode.MARKDOWN,
rich_text_media: list[types.InputRichMessageMedia] | None = None,
reply_markup: types.InlineKeyboardMarkup | type[object] | None = object,
link_preview_options: types.LinkPreviewOptions | None = None,
show_caption_above_media: bool | None = None,
disable_web_page_preview: bool | None = None,
business_connection_id: str | None = None,
schedule_date: datetime | timedelta | None = None,
) -> types.Message:
"""Edit the caption of media messages.
.. include:: /_includes/usable-by/users-bots.rst
Parameters:
chat_id (``int`` | ``str``):
Unique identifier (int) or username (str) of the target chat.
For your personal cloud (Saved Messages) you can simply use "me" or "self".
For a contact that exists in your Telegram address book you can use his phone number (str).
message_id (``int``):
Message identifier in the chat specified in chat_id.
caption (``str``):
New caption of the media 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`, *optional*):
List of special entities that appear in the caption, which can be specified instead of *parse_mode*.
rich_text (``str``, *optional*):
Rich text content with GitHub Flavored Markdown or HTML formatting (server-side rendered).
When provided, *caption*/*parse_mode*/*caption_entities* are ignored.
rich_text_parse_mode (:obj:`~pyrogram.enums.ParseMode`, *optional*):
Parse mode for *rich_text*: :obj:`~pyrogram.enums.ParseMode.MARKDOWN` (default, supports GFM) or :obj:`~pyrogram.enums.ParseMode.HTML`.
rich_text_media (List of :obj:`~pyrogram.types.InputRichMessageMedia`, *optional*):
Media *rich_text* refers to through ``tg://photo?id=``, ``tg://video?id=``
or ``tg://audio?id=`` links.
Ignored when *rich_text* is an :obj:`~pyrogram.types.InputRichMessage`.
reply_markup (:obj:`~pyrogram.types.InlineKeyboardMarkup`, *optional*):
An InlineKeyboardMarkup object.
Pass None to remove the existing reply markup.
link_preview_options (:obj:`~pyrogram.types.LinkPreviewOptions`, *optional*):
Link preview options.
show_caption_above_media (``bool``, *optional*):
Pass True, if the caption must be shown above the message media.
disable_web_page_preview (``bool``, *optional*):
Disables link previews for links in this message.
schedule_date (:py:obj:`~datetime.datetime`, *optional*):
Date when the message will be automatically sent.
business_connection_id (``str``, *optional*):
Unique identifier of the business connection on behalf of which the message will be edited.
Returns:
:obj:`~pyrogram.types.Message`: On success, the edited message is returned.
Example:
.. code-block:: python
await app.edit_message_caption(chat_id, message_id, "new media caption")
"""
return await self.edit_message_text(
chat_id=chat_id,
message_id=message_id,
text=caption,
parse_mode=parse_mode,
entities=caption_entities,
rich_text=rich_text,
rich_text_parse_mode=rich_text_parse_mode,
rich_text_media=rich_text_media,
reply_markup=reply_markup,
link_preview_options=link_preview_options,
show_caption_above_media=show_caption_above_media,
disable_web_page_preview=disable_web_page_preview,
business_connection_id=business_connection_id,
schedule_date=schedule_date,
)