62 lines
2.2 KiB
Python
62 lines
2.2 KiB
Python
# Pyrogram - Telegram MTProto API Client Library for Python
|
|
# Copyright (C) 2017-2019 Dan Tès <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.api import functions
|
|
from ...ext import BaseClient
|
|
|
|
|
|
class PinChatMessage(BaseClient):
|
|
async def pin_chat_message(
|
|
self,
|
|
chat_id: Union[int, str],
|
|
message_id: int,
|
|
disable_notification: bool = None
|
|
) -> bool:
|
|
"""Pin 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.
|
|
|
|
Parameters:
|
|
chat_id (``int`` | ``str``):
|
|
Unique identifier (int) or username (str) of the target chat.
|
|
|
|
message_id (``int``):
|
|
Identifier of a message to pin.
|
|
|
|
disable_notification (``bool``):
|
|
Pass True, if it is not necessary to send a notification to all chat members about the new pinned
|
|
message. Notifications are always disabled in channels.
|
|
|
|
Returns:
|
|
``bool``: True on success.
|
|
|
|
Raises:
|
|
RPCError: In case of a Telegram RPC error.
|
|
"""
|
|
await self.send(
|
|
functions.messages.UpdatePinnedMessage(
|
|
peer=await self.resolve_peer(chat_id),
|
|
id=message_id,
|
|
silent=disable_notification or None
|
|
)
|
|
)
|
|
|
|
return True
|