mirror of
https://github.com/Mayuri-Chan/pyrofork.git
synced 2025-12-29 20:14:51 +00:00
63 lines
2.2 KiB
Python
63 lines
2.2 KiB
Python
# Pyrofork - Telegram MTProto API Client Library for Python
|
|
# Copyright (C) 2017-present Dan <https://github.com/delivrance>
|
|
# Copyright (C) 2022-present Mayuri-Chan <https://github.com/Mayuri-Chan>
|
|
#
|
|
# This file is part of Pyrofork.
|
|
#
|
|
# Pyrofork 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.
|
|
#
|
|
# Pyrofork 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 Pyrofork. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
from typing import Union
|
|
|
|
import pyrogram
|
|
from pyrogram import raw
|
|
|
|
|
|
class UnpinChatMessage:
|
|
async def unpin_chat_message(
|
|
self: "pyrogram.Client",
|
|
chat_id: Union[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.
|
|
You can also use chat public link in form of *t.me/<username>* (str).
|
|
|
|
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
|