aiogram.api.methods.get_chat_administrators

aiogram/api/methods/get_chat_administrators.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
from __future__ import annotations

from typing import TYPE_CHECKING, Any, Dict, List, Union

from ..types import ChatMember
from .base import Request, TelegramMethod

if TYPE_CHECKING:  # pragma: no cover
    from ..client.bot import Bot


class GetChatAdministrators(TelegramMethod[List[ChatMember]]):
    """
    Use this method to get a list of administrators in a chat. On success, returns an Array of
    ChatMember objects that contains information about all chat administrators except other bots.
    If the chat is a group or a supergroup and no administrators were appointed, only the creator
    will be returned.

    Source: https://core.telegram.org/bots/api#getchatadministrators
    """

    __returning__ = List[ChatMember]

    chat_id: Union[int, str]
    """Unique identifier for the target chat or username of the target supergroup or channel (in
    the format @channelusername)"""

    def build_request(self, bot: Bot) -> Request:
        data: Dict[str, Any] = self.dict()

        return Request(method="getChatAdministrators", data=data)