aiogram.api.methods.get_chat

aiogram/api/methods/get_chat.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
from __future__ import annotations

from typing import TYPE_CHECKING, Any, Dict, Union

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

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


class GetChat(TelegramMethod[Chat]):
    """
    Use this method to get up to date information about the chat (current name of the user for
    one-on-one conversations, current username of a user, group or channel, etc.). Returns a Chat
    object on success.

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

    __returning__ = Chat

    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="getChat", data=data)