VKWebAppUpdateConfig

VKWebAppUpdateConfig отправляется платформой, когда изменяется конфигурация мини-приложения.

Клиент отправляет мини-приложению событие VKWebAppUpdateConfig с информацией об используемой конфигурации в следующих случаях:

  • Сразу после выполнения события VKWebAppInit.
  • При показе модального вью-контроллера.
  • При появлении, исчезновении или изменении размеров клавиатуры.
  • При изменении фрейма экрана, в том числе ориентации.
  • При изменении цветовой схемы.

Пример

JavaScriptbridge.subscribe((e) => { if (e.detail.type === 'VKWebAppUpdateConfig') { // Логика мини-приложения } });

Параметры

Результат

VKWebAppUpdateConfig сигнализирует, что информация получена. В качестве ответа платформа возвращает объект со следующими полями:

ПолеТипПлатформаЗначение
api_hoststringMobile Web, WebAPI-хост для вызовов, не использующих VK Bridge. Возможные значения:    • api.vk.com    • api.vk.ru
appstringAndroid, iOSТип клиента. Возможные значения:    • vkclient — приложение ВКонтакте.    • vkme — мессенджер ВКонтакте.
app_idstringAndroid, iOS, Mobile Web, WebИдентификатор приложения, которому соответствует нативное мобильное приложение ВКонтакте.
appearancestringAndroid, iOS, Mobile Web, WebТема мини-приложения или игры. Возможные значения:    • light— светлая тема.    • dark — тёмная тема.
insetsstringiOSТекущие отступы, которые необходимо выдержать от края экрана до контента (если показана клавиатура, её высота будет в bottom-инсете).
gaidstringAndroid, iOSGoogle Advertising ID.
sak_versionstringAndroid, iOSВерсия SuperAppKit.
schemestringAndroid, iOS, Mobile Web, WebЦветовая схема мини-приложения или игры. Возможные значения:    • space_gray — тёмная схема мобильного приложения и мобильной версии сайта.    • bright_light — светлая схема мобильного приложения и мобильной версии сайта.    • vkcom_light — светлая схема десктопной версии сайта.    • vkcom_dark — тёмная схема десктопной версии сайта.
start_timeintegerAndroid, iOSВремя и дата открытия модального экрана (Unix Timestamp). Передаётся только при открытии модального экрана.
viewport_heightintegerMobile Web, WebВысота родительского окна мини-приложения или игры.
viewport_widthintegerMobile Web, WebШирина родительского окна мини-приложения или игры.
is_layerbooleanWebПоле приходит, если мини-приложение или игра открыты в слое.

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

JavaScript{ detail: { type: "VKWebAppUpdateConfig", data: { api_host: "api.vk.com", app_id: "8142709", appearance: "light", scheme: "vkcom_light", viewport_height: 558, viewport_width: 1258 } } }

Пример обработки события

Смотрите раздел Обработка событий-результатов.