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