VKWebAppAddToFavorites

Важно! Событие станет доступно пользователям после того, как ваше приложение пройдёт модерацию.

VKWebAppAddToFavorites показывает окно с предложением добавить мини-приложение или игру в избранное.

Ссылка на мини-приложение или игру появится в левом меню десктопной версии ВКонтакте. Также мини-приложение, добавленное в избранные, можно найти в меню Сервисы → Избранное, игру — в меню Игры → Мои игры.

Избранные игры в левом меню
Избранные игры в разделе «Любимые игры»
Избранные мини-приложения в разделе «Избранное»

Пример

JavaScript
bridge.send('VKWebAppAddToFavorites') .then((data) => { if (data.result) { // Мини-приложение или игра добавлены в избранное } }) .catch((error) => { // Ошибка console.log(error); });

Платформы

Android, iOS, Mobile Web, Web

Параметры

—

Результат

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

  • •

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

  • •

    С помощью событий VKWebAppAddToFavoritesResult и VKWebAppAddToFavoritesFailed.

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

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

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

Объект Promise

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

Поле
Тип
Описание
result
boolean
true, если мини-приложение или игра добавлены в избранное.

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

События

VKWebAppAddToFavoritesResult

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

JavaScript
{ detail: { type: "VKWebAppAddToFavoritesResult", data: { result: true } } }

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

VKWebAppAddToFavoritesFailed

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

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

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

Подробнее — в разделе Обработка результата.

Песочница

VKWebAppAddToFavorites

Материалы по теме