54 lines
1.8 KiB
Python
54 lines
1.8 KiB
Python
|
# Pyrogram - Telegram MTProto API Client Library for Python
|
||
|
|
# Copyright (C) 2017-2020 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
|
||
|
|
|
||
|
|
from pyrogram import raw
|
||
|
|
from pyrogram.scaffold import Scaffold
|
||
|
|
|
||
|
|
|
||
|
|
class UnpinAllChatMessages(Scaffold):
|
||
|
|
async def unpin_all_chat_messages(
|
||
|
|
self,
|
||
|
|
chat_id: Union[int, str],
|
||
|
|
) -> bool:
|
||
|
|
"""Use this method to clear the list of pinned messages in a chat.
|
||
|
|
If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have
|
||
|
|
the 'can_pin_messages' admin right in a supergroup or 'can_edit_messages' admin right in a channel.
|
||
|
|
|
||
|
|
Parameters:
|
||
|
|
chat_id (``int`` | ``str``):
|
||
|
|
Unique identifier (int) or username (str) of the target chat.
|
||
|
|
|
||
|
|
Returns:
|
||
|
|
``bool``: True on success.
|
||
|
|
|
||
|
|
Example:
|
||
|
|
.. code-block:: python
|
||
|
|
|
||
|
|
# Unpin all chat messages
|
||
|
|
app.unpin_all_chat_messages(chat_id)
|
||
|
|
"""
|
||
|
|
await self.send(
|
||
|
|
raw.functions.messages.UnpinAllMessages(
|
||
|
|
peer=await self.resolve_peer(chat_id)
|
||
|
|
)
|
||
|
|
)
|
||
|
|
|
||
|
|
return True
|