Source code for pyrogram.methods.chats.pin_chat_message
# Pyrogram - Telegram MTProto API Client Library for Python
# Copyright (C) 2017-present 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 __future__ import annotations
import pyrogram
from pyrogram import raw, types
class PinChatMessage:
async def pin_chat_message(
self: pyrogram.Client,
chat_id: int | str,
message_id: int,
disable_notification: bool = False,
both_sides: bool = False,
business_connection_id: str | None = None,
) -> types.Message | None:
"""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.
.. 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``):
Identifier of a message to pin.
disable_notification (``bool``, *optional*):
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.
business_connection_id (``str``, *optional*):
Unique identifier of the business connection on behalf of which the
action is taken.
Returns:
:obj:`~pyrogram.types.Message` | ``None``: In groups and channels the service message is returned.
In private chats no service message is sent and None is returned.
Example:
.. code-block:: python
# Pin with notification
await app.pin_chat_message(chat_id, message_id)
# Pin without notification
await app.pin_chat_message(chat_id, message_id, disable_notification=True)
"""
r = await self.invoke(
raw.functions.messages.UpdatePinnedMessage(
peer=await self.resolve_peer(chat_id),
id=message_id,
silent=disable_notification if disable_notification is not None else None,
pm_oneside=not both_sides if both_sides is not None else None,
),
business_connection_id=business_connection_id,
)
users = {u.id: u for u in r.users}
chats = {c.id: c for c in r.chats}
for i in r.updates:
if isinstance(
i,
(
raw.types.UpdateNewMessage,
raw.types.UpdateNewChannelMessage,
raw.types.UpdateBotNewBusinessMessage,
),
):
return await types.Message._parse(
self,
i.message,
users,
chats,
business_connection_id=getattr(i, "connection_id", None),
raw_reply_to_message=getattr(i, "reply_to_message", None),
)