MAX Bridge

Библиотека MAX Bridge позволяет мини-приложениям корректно взаимодействовать с API MAX и API операционной системы на устройстве пользователя. В этом разделе содержится список объектов и событий MAX Bridge

Подключение библиотеки

Добавьте библиотеку max-web-app.js

HTML
<script src="https://st.max.ru/js/max-web-app.js"></script>

С подключением библиотеки мини-приложение получит доступ к глобальному объекту WebApp в window и сценариям для его использования

Объекты

Window.WebApp

Этот глобальный объект связывает мини-приложение с клиентом и позволяет взаимодействовать с MAX, управлять интерфейсом приложения и получать информацию о пользователях. Объект window.WebApp создаётся с каждым запуском сервиса, предзагружает данные и не требует отдельной инициализации — его методы и параметры доступны напрямую

ПолеТип данныхОписание
initDatastringОбъект со стартовыми параметрами, который как и WebAppInitData, применяется для отображения данных о пользователе в UI
initDataUnsafeWebAppInitDataОбъект со стартовыми параметрами, который не должен использоваться для валидации пользователей
onEvent()functionПодпишет на событие с использованием callback
ready()functionСообщит MAX, что мини-приложение готово к работе
close()functionЗакроет мини-приложение
requestContact()functionПопросит телефон у пользователя в нативном диалоговом окне
BackButtonBackButtonУправляет кнопкой Назад в шапке мини-приложения
enableClosingConfirmation()functionПредупредит пользователя о риске потерять заполненные данные, если закрыть мини-приложение
disableClosingConfIrmation()functionНе предупредит пользователя о риске потерять заполненные данные, если закрыть мини-приложение
openLink(link)functionОткроет ссылку во внешнем браузере

WebAppInitData

Этот объект содержит данные, которые мини-приложение получает при запуске. Совпадает с initData

ПараметрТип данныхОписание
query_idstringУникальный идентификатор сессии мини-приложения
auth_dateint32Время получения данных с бэкенда
hashstringХэш переданных параметров, который можно использовать для проверки их достоверности
userobjectОбъект с данными о пользователе, который открывает мини-приложение
idint64Уникальный идентификатор пользователя MAX
first_namestringИмя пользователя
last_namestringФамилия пользователя
usernamestringНик пользователя
language_code
stringЯзык интерфейса MAX
photo_urlstringСсылка на фото профиля пользователя
chatChatОбъект с данными о чате, из которого открыто мини-приложение
idnumberИдентификатор чата
typestringТип чата

BackButton

Этот объект управляет кнопкой Назад в шапке мини-приложения

ПолеТип данныхОписание
isVisiblebooleanЗадаёт состояние false по умолчанию
onClick()functionУстанавливает обработчик событий
offClick()functionУбирает обработчик событий нажатия кнопки
show()functionДелает кнопку Назад активной и видимой
hide()functionСкрывает кнопку Назад

ℹ️ Если у вас возникли вопросы, посмотрите раздел с ответами