Перейти к основному содержанию

MiniAppContext

Полный контекст, который хост передаёт MiniApp при handshake. Возвращается из app.init() и доступен через app.getContext().

MiniAppUser

number
обязательно
Внутренний идентификатор пользователя в Exode. Для неавторизованного посетителя (страница с опцией «Доступна без входа») — 0, остальные поля при этом пустые.
string | null
Публичный UUID пользователя.
string | null
Имя пользователя.
string | null
Фамилия пользователя.
object | null
Аватар: id и ссылки в трёх размерах — small, medium, maximum (каждая string | null).
string | null
Email пользователя.
string | null
Телефон пользователя.
string
обязательно
Роль: Student, Tutor, Parent и др.
string | null
Язык интерфейса: en, ru, uz, qa.

MiniAppTheme

MiniAppConfig

Platform

native означает, что Exode запущен внутри нативной оболочки (например, iOS/Android-приложение). В остальных случаях web. Систему устройства (ios / android / web) хост 0.4+ передаёт в поле os.

MiniAppViewport

Где стоит фрейм и что его закрывает (хост 0.4+). Обновляется событием viewport:changed.

MiniAppCapability

Что хост умеет для приложения (хост 0.4+): popup, prompt, haptic, header, backButton, mainButton, composer, composer.attachments, composer.voice, composer.dictation, composer.voiceOnly, composer.dictation.audio, composer.voiceOnly.review, composer.voiceOnly.noCancel, fullscreen, orientation, openLink, share, clipboard. Проверка — app.isSupported(capability); где какая возможность есть — на странице Нативный вид.

school

Поле school — публичные данные школы, которые использует само приложение Exode (например, name, domain, preferenceSettings). SDK типизирует его как Record<string, unknown>: состав полей не зафиксирован контрактом, поэтому проверяйте наличие нужного поля перед использованием.

События хоста (MiniAppEventMap)

Отправляются хостом при изменении данных. MiniApp подписывается через app.on(event, handler).
События theme:changed, user:updated, school:updated, config:updated, viewport:changed и context:updated bridge применяет к контексту из app.getContext() сам — см. Получение текущего контекста.

Команды MiniApp → хост (MiniAppCommandMap)

Вызываются через namespaces app.route и app.ui, а с SDK 0.4 — app.popup, app.haptic, app.header, app.backButton, app.mainButton, app.composer и app.viewport.
minimize сворачивает окно приложения и работает только для страниц с типом окна «Плавающее окно», «Панель справа» или «Во весь экран» (см. Кастомные страницы). Для типа «Страница» команда ничего не делает. Свёрнутое окно не выгружается: iframe живёт, состояние сохраняется, а приложение получает visibility:changed с visible: false.

BridgeMessage

Низкоуровневый формат сообщений postMessage. Обычно разработчику не нужен, но полезен при отладке.
Не отправляйте postMessage вручную. Все валидные взаимодействия идут через методы ExodeMiniApp — только они гарантируют корректный handshake, requestId и валидацию origin.

Импорт типов


Обновлено: 2026-10-22 23:06 UTC