VKWebAppAddToCommunity

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

VKWebAppAddToCommunity вызывает окно выбора сообщества и устанавливает в него приложение: мини-приложение или плагин.

Перед вызовом события из приложения включите Запуск приложения из сообщества.

Пример

JavaScript
bridge.send('VKWebAppAddToCommunity') .then((data) => { if (data.group_id) { // Приложение установлено в сообщество } }) .catch((error) => { // Ошибка console.log(error); });

Платформы

Android, iOS, Mobile Web, Web

Параметры

Поле
Тип
Описание
hide_success_modal необязательное
boolean
Указывает, нужно ли скрывать модальное окно об успешном добавлении приложения в сообщество.    • true — скрывать модальное окно.    • false — показывать модальное окно. Используется только в десктопной версии ВКонтакте. На других платформах модальное окно не отображается.

Результат

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

  • •

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

  • •

    С помощью событий VKWebAppAddToCommunityResult и VKWebAppAddToCommunityFailed.

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

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

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

Объект Promise

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

Поле
Тип
Описание
group_id
string
Идентификатор сообщества, в котором установлено приложение.

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

События

VKWebAppAddToCommunityResult

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

JavaScript
{ detail: { type: "VKWebAppAddToCommunityResult", data: { group_id: "166562603" } } }

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

VKWebAppAddToCommunityFailed

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

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

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

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

Песочница

VKWebAppAddToCommunity

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