Перейти к содержанию

GetChats

GetChats(bot, count=None, marker=None)

Bases: BaseConnection

Класс для получения списка чатов.

https://dev.max.ru/docs-api/methods/GET/chats

Attributes:

Name Type Description
bot Bot

Инициализированный клиент бота.
count Optional[int]

Максимальное количество чатов, возвращаемых за один запрос.
marker Optional[int]

Маркер для продолжения пагинации.
Source code in maxapi/methods/get_chats.py 
24
25
26
27
28
29
30
31
32
33
34
35
def __init__(
    self,
    bot: "Bot",
    count: Optional[int] = None,
    marker: Optional[int] = None,
):
    if count is not None and not (1 <= count <= 100):
        raise ValueError("count не должен быть меньше 1 или больше 100")

    self.bot = bot
    self.count = count
    self.marker = marker

fetch() async

Выполняет GET-запрос для получения списка чатов.

Returns:

Name Type Description
Chats Chats

Объект с данными по списку чатов.
Source code in maxapi/methods/get_chats.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
async def fetch(self) -> Chats:
    """
    Выполняет GET-запрос для получения списка чатов.

    Returns:
        Chats: Объект с данными по списку чатов.
    """

    bot = self._ensure_bot()

    params = bot.params.copy()

    if self.count:
        params["count"] = self.count

    if self.marker:
        params["marker"] = self.marker

    response = await super().request(
        method=HTTPMethod.GET,
        path=ApiPath.CHATS,
        model=Chats,
        params=params,
    )

    return cast(Chats, response)