78 lines
3.0 KiB
Python
78 lines
3.0 KiB
Python
# Pyrogram - Telegram MTProto API Client Library for Python
|
|
# Copyright (C) 2017-2021 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 typing import Union, List, Optional
|
|
|
|
from pyrogram import types
|
|
from pyrogram.scaffold import Scaffold
|
|
|
|
|
|
class EditMessageCaption(Scaffold):
|
|
async def edit_message_caption(
|
|
self,
|
|
chat_id: Union[int, str],
|
|
message_id: int,
|
|
caption: str,
|
|
parse_mode: Optional[str] = object,
|
|
caption_entities: List["types.MessageEntity"] = None,
|
|
reply_markup: "types.InlineKeyboardMarkup" = None
|
|
) -> "types.Message":
|
|
"""Edit the caption of media messages.
|
|
|
|
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 (``str``, *optional*):
|
|
By default, texts are parsed using both Markdown and HTML styles.
|
|
You can combine both syntaxes together.
|
|
Pass "markdown" or "md" to enable Markdown-style parsing only.
|
|
Pass "html" to enable HTML-style parsing only.
|
|
Pass None to completely disable style parsing.
|
|
|
|
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:
|
|
:obj:`~pyrogram.types.Message`: On success, the edited message is returned.
|
|
|
|
Example:
|
|
.. code-block:: python
|
|
|
|
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,
|
|
reply_markup=reply_markup
|
|
)
|