Updates#

Апдейты живут в maxo.types. Импорт из maxo.routing.updates устарел и оставлен только для обратной совместимости.

class maxo.types.BaseUpdate[исходный код]#

Базовые классы: MaxoType

BaseUpdate()

class maxo.types.MaxUpdate[исходный код]#

Базовые классы: BaseUpdate

Базовый класс для всех апдейтов из Макса.

У всех апдейтов есть тип (type, update\_type) и время (timestamp). Фасад (facade) объединяет методы для работы с апдейтом, например, отправить сообщение или ответить на колбэк.

type: ClassVar[UpdateType]#

timestamp: datetime#

property update_type: UpdateType#

class maxo.types.MessageCreated[исходный код]#

Базовые классы: MaxUpdate, MessageMethodsFacade

Вы получите это событие, как только сообщение будет создано

type = 'message_created'#

message: Message#: Новое созданное сообщение

user_locale: str | None | Omitted#: Текущий язык пользователя в формате IETF BCP 47. Доступно только в диалогах

property unsafe_user_locale: str#

property text: str | None#

property user_id: int | None#

class maxo.types.MessageCallback[исходный код]#

Базовые классы: MaxUpdate, CallbackMethodsFacade, MessageMethodsFacade

Вы получите это событие, как только пользователь нажмёт кнопку

type = 'message_callback'#

callback: Callback#

message: Message | None#: Изначальное сообщение, содержащее встроенную клавиатуру. Может быть null, если оно было удалено к моменту, когда бот получил это событие

user_locale: str | None | Omitted#: Текущий язык пользователя в формате IETF BCP 47

property unsafe_message: Message#

property unsafe_user_locale: str#

property callback_id: str#

property id: str#

property payload: str | Omitted#

property data: str | Omitted#

property user: User#

property from_user: User#

class maxo.types.MessageEdited[исходный код]#

Базовые классы: MaxUpdate, MessageMethodsFacade

Вы получите это событие, как только пользователь отредактирует сообщение

type = 'message_edited'#

message: Message#: Отредактированное сообщение

property text: str | None#

class maxo.types.MessageRemoved[исходный код]#

Базовые классы: MaxUpdate, ChatMethodsFacade

Вы получите это событие, как только сообщение будет удалено

type: ClassVar[UpdateType] = 'message_removed'#

chat_id: int#

//dev.max.ru/docs-api#Получение%20chat_id)

Type:: ID чата, где сообщение было удалено. Как получить ID - в [разделе «Получение chat_id»](https

message_id: str#: ID удалённого сообщения

user_id: int#: Пользователь, удаливший сообщение

class maxo.types.BotStarted[исходный код]#

Базовые классы: MaxUpdate, ChatMethodsFacade

Вы получите это событие, как только пользователь начнёт или возобновит общение с ботом: нажмёт соответствующую кнопку в настройках бота в МАКС

type: ClassVar[UpdateType] = 'bot_started'#

chat_id: int#

//dev.max.ru/docs-api#Получение%20chat_id)

Type:: ID диалога, где произошло событие. Как получить ID - в [разделе «Получение chat_id»](https

user: User#: Пользователь, который нажал кнопку Start

payload: str | None | Omitted#: Дополнительные данные из диплинков, переданные при запуске бота

user_locale: str | Omitted#: Текущий язык пользователя в формате IETF BCP 47

property unsafe_payload: str#

property unsafe_user_locale: str#

class maxo.types.BotStopped[исходный код]#

Базовые классы: MaxUpdate, ChatMethodsFacade

Вы получите это событие, как только пользователь остановит бота в его настройках в МАКС

type: ClassVar[UpdateType] = 'bot_stopped'#

chat_id: int#

//dev.max.ru/docs-api#Получение%20chat_id)

Type:: ID диалога, где произошло событие. Как получить ID - в [разделе «Получение chat_id»](https

user: User#: Пользователь, который остановил бота

user_locale: str | Omitted#: Текущий язык пользователя в формате IETF BCP 47

property unsafe_user_locale: str#

class maxo.types.BotAddedToChat[исходный код]#

Базовые классы: MaxUpdate, ChatMethodsFacade

Вы получите это событие, как только бот будет добавлен в чат или канал

type: ClassVar[UpdateType] = 'bot_added'#

chat_id: int#

//dev.max.ru/docs-api#Получение%20chat_id)

Type:: ID чата, куда был добавлен бот. Как получить ID - в [разделе «Получение chat_id»](https

is_channel: bool#: Указывает, что бот добавлен в канал, а не в чат

user: User#: Пользователь, добавивший бота в чат

class maxo.types.BotRemovedFromChat[исходный код]#

Базовые классы: MaxUpdate, ChatMethodsFacade

Вы получите это событие, как только бот будет удалён из чата

type: ClassVar[UpdateType] = 'bot_removed'#

chat_id: int#

//dev.max.ru/docs-api#Получение%20chat_id)

Type:: ID чата, откуда был удалён бот. Как получить ID - в [разделе «Получение chat_id»](https

is_channel: bool#: Указывает, что бот удалён из канала, а не из чата

user: User#: Пользователь, удаливший бота из чата

class maxo.types.UserAddedToChat[исходный код]#

Базовые классы: MaxUpdate, ChatMethodsFacade

Вы получите это событие, как только пользователь будет добавлен в чат, где бот является администратором

type: ClassVar[UpdateType] = 'user_added'#

chat_id: int#

//dev.max.ru/docs-api#Получение%20chat_id)

Type:: ID чата, где произошло событие. Как получить ID - в [разделе «Получение chat_id»](https

is_channel: bool#: Указывает, что пользователь добавлен в канал, а не в чат

user: User#: Пользователь, добавленный в чат

inviter_id: int | None | Omitted#: Пользователь, который добавил нового пользователя в чат. Может быть null, если пользователь присоединился к чату по ссылке

property unsafe_inviter_id: int#

class maxo.types.UserRemovedFromChat[исходный код]#

Базовые классы: MaxUpdate, ChatMethodsFacade

Вы получите это событие, как только пользователь будет удалён из чата, где бот является администратором

type: ClassVar[UpdateType] = 'user_removed'#

chat_id: int#

//dev.max.ru/docs-api#Получение%20chat_id)

Type:: ID чата, где произошло событие. Как получить ID - в [разделе «Получение chat_id»](https

is_channel: bool#: Указывает, что пользователь удалён из канала, а не из чата

user: User#: Пользователь, удалённый из чата

admin_id: int | Omitted#: Администратор, который удалил пользователя из чата. Может быть null, если пользователь покинул чат сам

property unsafe_admin_id: int#

class maxo.types.ChatTitleChanged[исходный код]#

Базовые классы: MaxUpdate, ChatMethodsFacade

Вы получите это событие, как только будет изменено название чата

type: ClassVar[UpdateType] = 'chat_title_changed'#

chat_id: int#

//dev.max.ru/docs-api#Получение%20chat_id)

Type:: ID чата, где произошло событие. Как получить ID - в [разделе «Получение chat_id»](https

title: str#: Новое название

user: User#: Пользователь, который изменил название

class maxo.types.DialogCleared[исходный код]#

Базовые классы: MaxUpdate, ChatMethodsFacade

Вы получите это событие, как только пользователь очистит историю сообщений

type: ClassVar[UpdateType] = 'dialog_cleared'#

chat_id: int#

//dev.max.ru/docs-api#Получение%20chat_id)

Type:: ID чата, где произошло событие. Как получить ID - в [разделе «Получение chat_id»](https

user: User#: Пользователь, который очистил историю сообщений

user_locale: str | Omitted#: Текущий язык пользователя в формате IETF BCP 47

property unsafe_user_locale: str#

class maxo.types.DialogMuted[исходный код]#

Базовые классы: MaxUpdate, ChatMethodsFacade

Вы получите это событие, как только пользователь отключит уведомления о новых сообщениях в диалоге с ботом

type: ClassVar[UpdateType] = 'dialog_muted'#

chat_id: int#

//dev.max.ru/docs-api#Получение%20chat_id)

Type:: ID чата, где произошло событие. Как получить ID - в [разделе «Получение chat_id»](https

muted_until: datetime#: Время в формате Unix, до наступления которого диалог был отключён

user: User#: Пользователь, который отключил уведомления

user_locale: str | Omitted#: Текущий язык пользователя в формате IETF BCP 47

property unsafe_user_locale: str#

class maxo.types.DialogUnmuted[исходный код]#

Базовые классы: MaxUpdate, ChatMethodsFacade

Вы получите это событие, как только пользователь включит уведомления о новых сообщениях в диалоге с ботом

type: ClassVar[UpdateType] = 'dialog_unmuted'#

chat_id: int#

//dev.max.ru/docs-api#Получение%20chat_id)

Type:: ID чата, где произошло событие. Как получить ID - в [разделе «Получение chat_id»](https

user: User#: Пользователь, который включил уведомления

user_locale: str | Omitted#: Текущий язык пользователя в формате IETF BCP 47

property unsafe_user_locale: str#

class maxo.types.DialogRemoved[исходный код]#

Базовые классы: MaxUpdate, ChatMethodsFacade

Вы получите это событие, как только пользователь удалит чат

type: ClassVar[UpdateType] = 'dialog_removed'#

chat_id: int#

//dev.max.ru/docs-api#Получение%20chat_id)

Type:: ID чата, где произошло событие. Как получить ID - в [разделе «Получение chat_id»](https

user: User#: Пользователь, который удалил чат

user_locale: str | Omitted#: Текущий язык пользователя в формате IETF BCP 47

property unsafe_user_locale: str#

class maxo.types.ErrorEvent[исходный код]#

Базовые классы: BaseUpdate, Generic[_ExceptionT, _UpdateT]

ErrorEvent(*, exception: ~_ExceptionT, update: maxo.routing.signals.update.MaxoUpdate[~_UpdateT])

exception: _ExceptionT#

update: MaxoUpdate[_UpdateT]#

property error: _ExceptionT#

property event: _UpdateT#