aiogram/aiogram/methods/unpin_chat_message.py
Alex Root Junior fea1b7b0a3
Reworked request builder (#1142)
* Reworked request builder

* Added more default values

* Update tests

* Fixed timestamp

* Fixed Py3.8 support

* Describe changes
2023-03-11 20:46:36 +02:00

21 lines
978 B
Python

from __future__ import annotations
from typing import TYPE_CHECKING, Optional, Union
from .base import TelegramMethod
class UnpinChatMessage(TelegramMethod[bool]):
"""
Use this method to remove a message from 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#unpinchatmessage
"""
__returning__ = bool
__api_method__ = "unpinChatMessage"
chat_id: Union[int, str]
"""Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)"""
message_id: Optional[int] = None
"""Identifier of a message to unpin. If not specified, the most recent pinned message (by sending date) will be unpinned."""