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

EditChat

EditChat(bot, chat_id, icon=None, title=None, pin=None, *, notify=None)

Bases: BaseConnection

Класс для редактирования информации о чате через API.

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

Attributes:

Name Type Description
bot

Экземпляр бота для выполнения запроса.
chat_id

Идентификатор чата для редактирования.
icon

Новый значок (иконка) чата.
title

Новое название чата.
pin

Идентификатор закреплённого сообщения.
notify

Включение или отключение уведомлений (по умолчанию True).
Source code in maxapi/methods/edit_chat.py 
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
def __init__(
    self,
    bot: "Bot",
    chat_id: int,
    icon: PhotoAttachmentRequestPayload | None = None,
    title: str | None = None,
    pin: str | None = None,
    *,
    notify: bool | None = None,
):
    if title is not None and not (1 <= len(title) <= 200):
        raise ValueError(
            "title не должен быть меньше 1 или больше 200 символов"
        )

    super().__init__()
    self.bot = bot
    self.chat_id = chat_id
    self.icon = icon
    self.title = title
    self.pin = pin
    self.notify = notify

fetch() async

Выполняет PATCH-запрос для обновления параметров чата.

Валидация
  • Проверяется, что в icon атрибуты модели взаимоисключающие (в модели должно быть ровно 2 поля с None).
  • Если условие не выполнено, логируется ошибка и запрос не отправляется.

Returns:

Name Type Description
Chat Chat

Обновлённый объект чата.
Source code in maxapi/methods/edit_chat.py 
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
async def fetch(self) -> Chat:
    """
    Выполняет PATCH-запрос для обновления параметров чата.

    Валидация:
        - Проверяется, что в `icon` атрибуты модели
            взаимоисключающие (в модели должно быть ровно 2 поля
            с None).
        - Если условие не выполнено, логируется ошибка и запрос
            не отправляется.

    Returns:
        Chat: Обновлённый объект чата.
    """

    bot = self._ensure_bot()

    json: dict[str, Any] = {}

    if self.icon:
        dump = self.icon.model_dump()

        if sum(value is not None for value in dump.values()) != 1:
            raise MaxIconParamsException(
                "Все атрибуты модели Icon являются взаимоисключающими | "
                "https://dev.max.ru/docs-api/methods/PATCH/chats/-chatId-"
            )

        json["icon"] = dump

    if self.title:
        json["title"] = self.title
    if self.pin:
        json["pin"] = self.pin
    if self.notify is not None:
        json["notify"] = self.notify

    response = await super().request(
        method=HTTPMethod.PATCH,
        path=ApiPath.CHATS.value + "/" + str(self.chat_id),
        model=Chat,
        params=bot.params,
        json=json,
    )

    return cast(Chat, response)