-
-
Notifications
You must be signed in to change notification settings - Fork 48
Expand file tree
/
Copy pathunpin_chat_message.py
More file actions
58 lines (47 loc) · 2.11 KB
/
unpin_chat_message.py
File metadata and controls
58 lines (47 loc) · 2.11 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
# 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 __future__ import annotations
import hydrogram
from hydrogram import raw
class UnpinChatMessage:
async def unpin_chat_message(
self: hydrogram.Client, chat_id: int | str, message_id: int = 0
) -> bool:
"""Unpin a message in a group, channel or your own chat.
You must be an administrator in the chat for this to work and must have the "can_pin_messages" admin
right in the supergroup or "can_edit_messages" admin right in the channel.
.. include:: /_includes/usable-by/users-bots.rst
Parameters:
chat_id (``int`` | ``str``):
Unique identifier (int) or username (str) of the target chat.
message_id (``int``, *optional*):
Identifier of a message to unpin.
If not specified, the most recent pinned message (by sending date) will be unpinned.
Returns:
``bool``: True on success.
Example:
.. code-block:: python
await app.unpin_chat_message(chat_id, message_id)
"""
await self.invoke(
raw.functions.messages.UpdatePinnedMessage(
peer=await self.resolve_peer(chat_id), id=message_id, unpin=True
)
)
return True