aiogram/aiogram/methods/set_chat_description.py
2020-11-16 23:32:37 +02:00

31 lines
989 B
Python

from __future__ import annotations
from typing import TYPE_CHECKING, Any, Dict, Optional, Union
from .base import Request, TelegramMethod
if TYPE_CHECKING: # pragma: no cover
from ..client.bot import Bot
class SetChatDescription(TelegramMethod[bool]):
"""
Use this method to change the description of a group, a supergroup or a channel. The bot must
be an administrator in the chat for this to work and must have the appropriate admin rights.
Returns True on success.
Source: https://core.telegram.org/bots/api#setchatdescription
"""
__returning__ = bool
chat_id: Union[int, str]
"""Unique identifier for the target chat or username of the target channel (in the format
@channelusername)"""
description: Optional[str] = None
"""New chat description, 0-255 characters"""
def build_request(self, bot: Bot) -> Request:
data: Dict[str, Any] = self.dict()
return Request(method="setChatDescription", data=data)