MTPyroger/pyrogram/methods/chats/pin_chat_message.py

74 lines
2.7 KiB
Python
Raw Normal View History

2020-03-21 14:43:32 +00:00
# Pyrogram - Telegram MTProto API Client Library for Python
2021-01-01 21:58:48 +00:00
# Copyright (C) 2017-2021 Dan <https://github.com/delivrance>
2018-07-08 09:00:56 +00:00
#
2020-03-21 14:43:32 +00:00
# This file is part of Pyrogram.
2018-07-08 09:00:56 +00:00
#
2020-03-21 14:43:32 +00:00
# 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.
2018-07-08 09:00:56 +00:00
#
2020-03-21 14:43:32 +00:00
# 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.
2018-07-08 09:00:56 +00:00
#
2020-03-21 14:43:32 +00:00
# You should have received a copy of the GNU Lesser General Public License
# along with Pyrogram. If not, see <http://www.gnu.org/licenses/>.
2018-07-08 09:00:56 +00:00
from typing import Union
from pyrogram import raw
from pyrogram.scaffold import Scaffold
2018-07-08 09:00:56 +00:00
class PinChatMessage(Scaffold):
async def pin_chat_message(
2019-03-16 18:23:23 +00:00
self,
chat_id: Union[int, str],
message_id: int,
disable_notification: bool = False,
both_sides: bool = False,
2019-03-16 18:23:23 +00:00
) -> bool:
"""Pin a message in a group, channel or your own chat.
2018-07-13 22:44:50 +00:00
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:
2018-07-13 22:44:50 +00:00
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``, *optional*):
2018-07-13 22:44:50 +00:00
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.
both_sides (``bool``, *optional*):
Pass True to pin the message for both sides (you and recipient).
Applicable to private chats only. Defaults to False.
2018-07-13 22:44:50 +00:00
Returns:
``bool``: True on success.
2018-07-13 22:44:50 +00:00
2019-07-25 09:22:14 +00:00
Example:
.. code-block:: python
# Pin with notification
app.pin_chat_message(chat_id, message_id)
# Pin without notification
app.pin_chat_message(chat_id, message_id, disable_notification=True)
2018-07-13 22:44:50 +00:00
"""
await self.send(
raw.functions.messages.UpdatePinnedMessage(
peer=await self.resolve_peer(chat_id),
id=message_id,
silent=disable_notification or None,
pm_oneside=not both_sides or None
2018-07-08 09:00:56 +00:00
)
)
2019-03-16 18:23:23 +00:00
return True