-
-
Notifications
You must be signed in to change notification settings - Fork 48
Expand file tree
/
Copy pathedit_inline_caption.py
More file actions
67 lines (55 loc) · 2.33 KB
/
edit_inline_caption.py
File metadata and controls
67 lines (55 loc) · 2.33 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
# Hydrogram - Telegram MTProto API Client Library for Python
# Copyright (C) 2017-2023 Dan <https://github.com/delivrance>
# Copyright (C) 2023-present Hydrogram <https://hydrogram.org>
#
# This file is part of Hydrogram.
#
# Hydrogram 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.
#
# Hydrogram 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 Hydrogram. If not, see <http://www.gnu.org/licenses/>.
from typing import TYPE_CHECKING, Optional
if TYPE_CHECKING:
import hydrogram
from hydrogram import enums, types
class EditInlineCaption:
async def edit_inline_caption(
self: "hydrogram.Client",
inline_message_id: str,
caption: str,
parse_mode: Optional["enums.ParseMode"] = None,
reply_markup: "types.InlineKeyboardMarkup" = None,
) -> bool:
"""Edit the caption of inline media messages.
.. include:: /_includes/usable-by/bots.rst
Parameters:
inline_message_id (``str``):
Identifier of the inline message.
caption (``str``):
New caption of the media message.
parse_mode (:obj:`~hydrogram.enums.ParseMode`, *optional*):
By default, texts are parsed using both Markdown and HTML styles.
You can combine both syntaxes together.
reply_markup (:obj:`~hydrogram.types.InlineKeyboardMarkup`, *optional*):
An InlineKeyboardMarkup object.
Returns:
``bool``: On success, True is returned.
Example:
.. code-block:: python
# Bots only
await app.edit_inline_caption(inline_message_id, "new media caption")
"""
return await self.edit_inline_text(
inline_message_id=inline_message_id,
text=caption,
parse_mode=parse_mode,
reply_markup=reply_markup,
)