VKWebAppAddToHomeScreen
VKWebAppAddToHomeScreen
показывает окно с предложением добавить ярлык мини-приложения или игры на экран устройства. Чтобы убедиться, что ярлык ещё не был добавлен, вызовите событие VKWebAppAddToHomeScreenInfo
.
Пример
bridge.send('VKWebAppAddToHomeScreen')
.then((data) => {
if (data.result) {
// Ярлык мини-приложения или игры добавлен на экран устройства
}
})
.catch((error) => {
// Ошибка
console.log(error);
});
Платформы
Android
Параметры
—
Результат
Проверить результат можно:
- •
Используя объект
Promise
, который возвращается вызовомbridge.send(...)
. - •
С помощью событий
VKWebAppAddToHomeScreenResult
иVKWebAppAddToHomeScreenFailed
.
Подробнее о проверке результатов при вызовах VK Bridge.
Возможные ошибки:
- •
This action cannot be performed in the background
, если мини-приложение или игра запущены в фоновом режиме. - •
User denied
, если пользователь запретил доступ.
Объект Promise
Если вызов к платформе прошёл успешно, управление будет передано в then
-обработчик объекта Promise
. В качестве ответа платформа возвращает объект со следующим полем:
Поле | Тип | Описание |
---|---|---|
result | boolean | true , если ярлык мини-приложения или игры добавлен на главный экран устройства. |
Если при обращении к платформе произошла ошибка, управление передаётся в метод catch
. В качестве ответа платформа возвращает объект с информацией об ошибке, общий для всех событий VK Bridge.
События
VKWebAppAddToHomeScreenResult
Сигнализирует, что ярлык мини-приложения или игры добавлен на главный экран устройства. В обработчик события на стороне пользователя передаются следующие данные:
{
detail: {
type: "VKWebAppAddToHomeScreenResult",
data: {
result: true
}
}
}
Передаваемый объект подобен объекту, возвращаемому при успешном выполнении промиса.
VKWebAppAddToHomeScreenFailed
Информирует об ошибке, которая произошла при взаимодействии с платформой.
В обработчик события на стороне пользователя передаётся объект с информацией об ошибке, общий для всех методов VK Bridge.
Пример обработки событий
Смотри раздел Обработка событий-результатов.