MAX Bridge
Библиотека MAX Bridge позволяет мини-приложениям корректно взаимодействовать с API MAX и API операционной системы на устройстве пользователя. В этом разделе содержится список объектов и событий MAX Bridge
Подключение библиотеки
Добавьте библиотеку
<script src="https://st.max.ru/js/max-web-app.js"></script>
Для подключения может понадобиться импорт, чтобы произошла инициализация объекта WebApp в window — import 'max-web-app'. С подключением библиотеки мини-приложение получит доступ к глобальным объектам и сценариям для их использования
Объекты
Window.WebApp
Это глобальный объект, который связывает мини-приложение с клиентом и позволяет получать информацию о пользователе, управлять интерфейсом приложения и взаимодействовать с функциональностью MAX. MAX автоматически создаёт объект window.WebApp и предзагружает данные, когда пользователь открывает мини-приложение на платформе. Методы и свойства этого объекта доступны напрямую через window.WebApp без необходимости отдельной инициализации.
Вместе с объектом window.WebApp мини-приложению станут доступны следующие поля.
| Поле | Тип данных | Описание |
|---|---|---|
initData | string | Строка со стартовыми параметрами мини-приложения. С этим полем совпадает объект WebAppInitData, который может быть полезен при необходимости отображения данных о пользователе в UI на фронтенде приложения. |
initDataUnsafe | WebAppInitData | Объект со стартовыми параметрами. Не должен использоваться для валидации пользователя. |
onEvent() | function | Подпишет на событие с использованием callback — WebAppRequestPhone для для запроса номера телефона или WebAppBackButtonPressed при нажатии на кнопку «Назад» |
ready() | function | Метод, который сообщает MAX, что мини-приложение готово к работе (скрывается экран с загрузкой) |
close() | function | Закрытие мини-приложения |
requestContact() | function | Запрос номера телефона у пользователя в нативном диалоговом окне |
BackButton | BackButton | Управляет кнопкой Назад в шапке мини-приложения |
enableClosingConfirmation() | function | Предупредит пользователя о риске потерять заполненные данные, если закрыть мини-приложение |
disableClosingConfIrmation() | function | Не предупредит пользователя о риске потерять заполненные данные, если закрыть мини-приложение |
openLink(link) | function | Откроет ссылку во внешнем браузере |
WebAppInitData
Этот объект содержит данные, которые мини-приложение получает при запуске. Совпадает с initData
| Параметр | Тип данных | Описание |
|---|---|---|
chat | Chat | |
• id | number | Идентификатор чата |
• type | string | Тип чата |
query_id | string | Уникальный идентификатор сессии мини-приложения |
auth_date | int32 | Время получения данных с бэкенда (Unix-time) |
hash | string | Хэш переданных параметров для проверки подлинности данных |
• user | object | Объект с данными о пользователе, который открывает мини-приложение |
• id | int64 | Уникальный идентификатор пользователя MAX |
• first_name | string | Имя пользователя |
• last_name | string | Фамилия пользователя |
• username | string | Короткое имя пользователя |
• language_code | string | Язык интерфейса MAX |
• photo_url | string | Ссылка на фото профиля пользователя |
BackButton
Этот объект управляет кнопкой Назад в шапке мини-приложения
| Поле | Тип данных | Описание |
|---|---|---|
isVisible | boolean | Задаёт состояние false по умолчанию |
onClick() | function | Устанавливает обработчика событий |
offClick() | function | Убирает обработчик событий нажатия кнопки |
show() | function | Делает кнопку Назад активной и видимой |
hide() | function | Скрывает кнопку Назад |
Если у вас возникли вопросы, посмотрите раздел с ответами