Updates¶

class maxo.routing.updates.BaseUpdate[исходный код]¶

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

BaseUpdate()

class maxo.routing.updates.BotAddedToChat[исходный код]¶

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

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

Параметры:

chat_id – ID чата, куда был добавлен бот
is_channel – Указывает, что бот добавлен в канал, а не в чат
type
user – Пользователь, добавивший бота в чат

type: ClassVar[UpdateType] = 'bot_added'¶

chat_id: int¶: ID чата, куда был добавлен бот

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

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

class maxo.routing.updates.BotRemovedFromChat[исходный код]¶

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

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

Параметры:

chat_id – ID чата, откуда был удалён бот
is_channel – Указывает, что бот удалён из канала, а не из чата
type
user – Пользователь, удаливший бота из чата

type: ClassVar[UpdateType] = 'bot_removed'¶

chat_id: int¶: ID чата, откуда был удалён бот

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

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

class maxo.routing.updates.BotStarted[исходный код]¶

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

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

Параметры:

chat_id – ID диалога, где произошло событие
payload – Дополнительные данные из диплинков, переданные при запуске бота
type
user – Пользователь, который нажал кнопку Start
user_locale – Текущий язык пользователя в формате IETF BCP 47

type: ClassVar[UpdateType] = 'bot_started'¶

chat_id: int¶: ID диалога, где произошло событие

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.routing.updates.BotStopped[исходный код]¶

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

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

Параметры:

chat_id – ID диалога, где произошло событие
type
user – Пользователь, который остановил бота
user_locale – Текущий язык пользователя в формате IETF BCP 47

type: ClassVar[UpdateType] = 'bot_stopped'¶

chat_id: int¶: ID диалога, где произошло событие

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

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

property unsafe_user_locale: str¶

maxo.routing.updates.CallbackQuery¶: псевдоним для MessageCallback

class maxo.routing.updates.ChatTitleChanged[исходный код]¶

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

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

Параметры:

chat_id – ID чата, где произошло событие
title – Новое название
type
user – Пользователь, который изменил название

type: ClassVar[UpdateType] = 'chat_title_changed'¶

chat_id: int¶: ID чата, где произошло событие

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

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

class maxo.routing.updates.DialogCleared[исходный код]¶

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

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

Параметры:

chat_id – ID чата, где произошло событие
type
user – Пользователь, который очистил историю сообщений
user_locale – Текущий язык пользователя в формате IETF BCP 47

type: ClassVar[UpdateType] = 'dialog_cleared'¶

chat_id: int¶: ID чата, где произошло событие

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

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

property unsafe_user_locale: str¶

class maxo.routing.updates.DialogMuted[исходный код]¶

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

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

Параметры:

chat_id – ID чата, где произошло событие
muted_until – Время в формате Unix, до наступления которого диалог был отключён
type
user – Пользователь, который отключил уведомления
user_locale – Текущий язык пользователя в формате IETF BCP 47

type: ClassVar[UpdateType] = 'dialog_muted'¶

chat_id: int¶: ID чата, где произошло событие

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

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

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

property unsafe_user_locale: str¶

class maxo.routing.updates.DialogRemoved[исходный код]¶

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

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

Параметры:

chat_id – ID чата, где произошло событие
type
user – Пользователь, который удалил чат
user_locale – Текущий язык пользователя в формате IETF BCP 47

type: ClassVar[UpdateType] = 'dialog_removed'¶

chat_id: int¶: ID чата, где произошло событие

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

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

property unsafe_user_locale: str¶

class maxo.routing.updates.DialogUnmuted[исходный код]¶

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

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

Параметры:

chat_id – ID чата, где произошло событие
type
user – Пользователь, который включил уведомления
user_locale – Текущий язык пользователя в формате IETF BCP 47

type: ClassVar[UpdateType] = 'dialog_unmuted'¶

chat_id: int¶: ID чата, где произошло событие

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

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

property unsafe_user_locale: str¶

class maxo.routing.updates.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¶

class maxo.routing.updates.MaxUpdate[исходный код]¶

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

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

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

type: ClassVar[UpdateType]¶

timestamp: datetime¶

property update_type: UpdateType¶

class maxo.routing.updates.MessageCallback[исходный код]¶

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

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

Параметры:

callback
message – Изначальное сообщение, содержащее встроенную клавиатуру. Может быть null, если оно было удалено к моменту, когда бот получил это событие
type
user_locale – Текущий язык пользователя в формате IETF BCP 47

type: ClassVar[UpdateType] = '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 user: User¶

property from_user: User¶

class maxo.routing.updates.MessageCreated[исходный код]¶

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

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

Параметры:

message – Новое созданное сообщение
type
user_locale – Текущий язык пользователя в формате IETF BCP 47. Доступно только в диалогах

type: ClassVar[UpdateType] = '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.routing.updates.MessageEdited[исходный код]¶

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

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

Параметры:

message – Отредактированное сообщение
type

type: ClassVar[UpdateType] = 'message_edited'¶

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

property text: str | None¶

class maxo.routing.updates.MessageRemoved[исходный код]¶

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

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

Параметры:

chat_id – ID чата, где сообщение было удалено
message_id – ID удалённого сообщения
type
user_id – Пользователь, удаливший сообщение

type: ClassVar[UpdateType] = 'message_removed'¶

chat_id: int¶: ID чата, где сообщение было удалено

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

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

class maxo.routing.updates.UserAddedToChat[исходный код]¶

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

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

Параметры:

chat_id – ID чата, где произошло событие
inviter_id – Пользователь, который добавил нового пользователя в чат. Может быть null, если пользователь присоединился к чату по ссылке
is_channel – Указывает, что пользователь добавлен в канал, а не в чат
type
user – Пользователь, добавленный в чат

type: ClassVar[UpdateType] = 'user_added'¶

chat_id: int¶: ID чата, где произошло событие

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

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

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

property unsafe_inviter_id: int¶

class maxo.routing.updates.UserRemovedFromChat[исходный код]¶

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

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

Параметры:

admin_id – Администратор, который удалил пользователя из чата. Может быть null, если пользователь покинул чат сам
chat_id – ID чата, где произошло событие
is_channel – Указывает, что пользователь удалён из канала, а не из чата
type
user – Пользователь, удалённый из чата

type: ClassVar[UpdateType] = 'user_removed'¶

chat_id: int¶: ID чата, где произошло событие

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

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

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

property unsafe_admin_id: int¶