forked from TelegramPlayground/PyroTGFork
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathedit_message_caption.py
More file actions
98 lines (80 loc) · 3.91 KB
/
Copy pathedit_message_caption.py
File metadata and controls
98 lines (80 loc) · 3.91 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
# 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 datetime import datetime
from typing import Union, Optional
import pyrogram
from pyrogram import types, enums
class EditMessageCaption:
async def edit_message_caption(
self: "pyrogram.Client",
chat_id: Union[int, str],
message_id: int,
caption: str,
parse_mode: Optional["enums.ParseMode"] = None,
caption_entities: list["types.MessageEntity"] = None,
show_caption_above_media: bool = None,
reply_markup: "types.InlineKeyboardMarkup" = None,
schedule_date: datetime = None,
business_connection_id: str = 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`):
List of special entities that appear in the caption, which can be specified instead of *parse_mode*.
show_caption_above_media (``bool``, *optional*):
Pass True, if the caption must be shown above the message media. Supported only for animation, photo and video messages.
reply_markup (:obj:`~pyrogram.types.InlineKeyboardMarkup`, *optional*):
An InlineKeyboardMarkup object.
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 to be edited was sent
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")
"""
link_preview_options = None
if show_caption_above_media:
link_preview_options = types.LinkPreviewOptions(
show_above_text=show_caption_above_media
)
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,
link_preview_options=link_preview_options,
schedule_date=schedule_date,
business_connection_id=business_connection_id
)