mirror of
https://github.com/aiogram/aiogram.git
synced 2026-04-08 16:37:47 +00:00
* Reworked request builder * Added more default values * Update tests * Fixed timestamp * Fixed Py3.8 support * Describe changes
23 lines
1.1 KiB
Python
23 lines
1.1 KiB
Python
from __future__ import annotations
|
|
|
|
from typing import TYPE_CHECKING, Optional, Union
|
|
|
|
from .base import TelegramMethod
|
|
|
|
|
|
class PinChatMessage(TelegramMethod[bool]):
|
|
"""
|
|
Use this method to add a message to 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' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns :code:`True` on success.
|
|
|
|
Source: https://core.telegram.org/bots/api#pinchatmessage
|
|
"""
|
|
|
|
__returning__ = bool
|
|
__api_method__ = "pinChatMessage"
|
|
|
|
chat_id: Union[int, str]
|
|
"""Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)"""
|
|
message_id: int
|
|
"""Identifier of a message to pin"""
|
|
disable_notification: Optional[bool] = None
|
|
"""Pass :code:`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 and private chats."""
|