VKWebAppGetConfig

VKWebAppGetConfig получает информацию о конфигурации используемого мини-приложения или игры (информацию о родительском приложении, в котором открыто мини-приложение или игра).

Пример

JavaScript

bridge.send('VKWebAppGetConfig')
  .then((data) => { 
    if (data.api_host) {
      // Информация получена
    }
  })
  .catch((error) => {
    // Ошибка
    console.log(error);
  });

Совет. Используйте это событие, если вам нужно получить конфигурацию до вызова события VKWebAppInit. В остальных случаях используйте стандартный способ получения конфигурации — подпишитесь на событие VKWebAppUpdateConfig.

Платформы

Android, iOS, Mobile Web, Web

Параметры

—

Результат

Проверить результат можно:

•

Используя объект Promise, который возвращается вызовом bridge.send(...).
•

С помощью события VKWebAppGetConfigResult.

Подробнее о проверке результатов при вызовах VK Bridge.

Объект `Promise`

Если обращение к платформе прошло успешно, управление будет передано в then-обработчик объекта Promise. В качестве ответа платформа возвращает объект со следующими полями:

Поле	Тип	Платформа	Значение
`api_host`	`string`	Mobile Web, Web	API-хост для вызовов, не использующих VK Bridge. Возможные значения: • `api.vk.com` • `api.vk.ru`
`app`	`string`	Android, iOS	Тип клиента. Возможные значения: • `vkclient` — приложение ВКонтакте. • `vkme` — мессенджер ВКонтакте.
`app_id`	`string`	Android, iOS, Mobile Web, Web	Идентификатор родительского приложения.
`appearance`	`string`	Android, iOS, Mobile Web, Web	Тема мини-приложения или игры. Возможные значения: • `light`— светлая тема. • `dark` — тёмная тема.
`insets`	`string`	iOS	Текущие отступы, которые необходимо выдержать от края экрана до контента (если показана клавиатура, её высота будет в bottom-инсете).
`gaid`	`string`	Android, iOS	Google Advertising ID.
`sak_version`	`string`	Android, iOS	Версия SuperAppKit.
`scheme`	`string`	Android, iOS, Mobile Web, Web	Цветовая схема мини-приложения или игры. Возможные значения: • `space_gray` — тёмная схема мобильного приложения и мобильной версии сайта. • `bright_light` — светлая схема мобильного приложения и мобильной версии сайта. • `vkcom_light` — светлая схема десктопной версии сайта. • `vkcom_dark` — тёмная схема десктопной версии сайта.
`start_time`	`integer`	Android, iOS	Время и дата открытия модального экрана (Unix Timestamp). Передаётся только при открытии модального экрана.
`viewport_height`	`integer`	Mobile Web, Web	Высота родительского окна мини-приложения или игры.
`viewport_width`	`integer`	Mobile Web, Web	Ширина родительского окна мини-приложения или игры.
`is_layer`	`boolean`	Web	Поле приходит, если мини-приложение или игра открыты в слое.

Если при обращении к платформе произошла ошибка, управление передаётся в метод catch. В качестве ответа платформа возвращает объект с информацией об ошибке, общий для всех событий VK Bridge.

События

`VKWebAppGetConfigResult`

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

JavaScript

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

Передаваемый объект подобен объекту, возвращаемому при успешном выполнении промиса.

`VKWebAppGetConfigFailed`

Информирует об ошибке, которая произошла при взаимодействии с платформой.

В обработчик события на стороне пользователя передаётся объект с информацией об ошибке, общий для всех методов VK Bridge.

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

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