ДокументацияAPIСообществоСоздать приложение
Войти

VKWebAppClose

VKWebAppClose закрывает мини-приложение или игру. Если закрываемое мини-приложение или игра были запущены с помощью события VKWebAppOpenApp, при успешном закрытии в родительское приложение будет передано событие VKWebAppCloseResult.

Пример

JavaScriptbridge.send('VKWebAppClose', { status: 'success', payload: { name: 'value' }}) .then((data) => { if (data.status) { // Событие отправлено } }) .catch((error) => { // Ошибка console.log(error); });

Платформы

Android, iOS, Mobile Web, Web

Параметры

ПолеТипОписание
status обязательноеstringСтатус закрытия мини-приложения или игры, передаваемый в родительское приложение. Возможные значения:    • success — мини-приложение или игра закрылись успешно.    • failed — мини-приложение или игра закрылись с ошибкой.
payload необязательноеobjectДанные, передаваемые в родительское приложение.

Результат

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

  • •

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

  • •

    С помощью событий VKWebAppCloseResult и VKWebAppCloseFailed.

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

Возможные ошибки:

  • •
    This action cannot be performed in the background, если мини-приложение или игра запущены в фоновом режиме.

Объект Promise

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

ПолеТипОписание
statusstringСтатус закрытия мини-приложения или игры, передаваемый в родительское приложение. Возможные значения:    • success — мини-приложение или игра закрылись успешно.    • failed — мини-приложение или игра закрылись с ошибкой.
payloadobjectДанные, передаваемые в родительское приложение.

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

События

VKWebAppCloseResult

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

JavaScript{ detail: { type: "VKWebAppCloseResult", data: { status: "success", payload: { name: "value" } } } }

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

VKWebAppCloseFailed

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

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

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

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

Песочница

VKWebAppClose