Сигнатура метода

Метод предназначен для вступления пользователем в группу, привязанную к приложению в его настройках, а также для опционального включения сообщений в этой группе для пользователя.

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

Рекомендуем ознакомиться с инструментом Bot API, который позволяет рассылать сообщения от группы пользователям, которые разрешили получение сообщений от группы.

FAPI.UI.joinGroup(groupId, enableMessages);

где:

• groupId - id группы приложения, она должна быть указана в качестве официальной группы в настройках приложения;
• enableMessages - включить ли сообщения в группе для пользователя.

Пример вызова

 
/ *
  * Функция инициирует вступление в группу и запрос разрешения на отправку ему сообщений
  * Если пользователь уже участник группы, но не включил сообщения, то ему будет предложено включить сообщения
  */
  function joinGroup() {
    FAPI.UI.joinGroup(123123123, true);
  }
  

Рекомендации по использованию метода

Перед вызовом метода рекомендуется проверять текущий статус пользователя:

• является ли пользователь участником группы - метод group.getUserGroupsV2;
• разрешил ли пользователь сообщения от группы - метод group.isMessagesAllowed.

Также обратите внимание, чтобы ваша группа соответствовала следующим условиям:

• группа должна быть открытой;
• группа не должна иметь ограничение по возрасту пользователей;
• группа должна быть привязана к игре в настройках игры;
• если вы планируете отправлять сообщения от группы пользователям, то групповые сообщения также должны быть включены в настройках группы (подробнее о групповых сообщениях)

Пример коллбека

В результате выполнения метода вызывается клиентский коллбек, в котором передается результат его выполнения.

Коллбек при успешном вызове метода

Коллбек при ошибке выполнения метода / отмене вызова

Коды ошибок

При возникновении ошибки в поле data коллбека возвращается код ошибки, который однозначно определяет причину этой ошибки:

• cancel - пользователь отменил вступление в группу;
• already.member - пользователь уже является участником группы;
• group.access.denied - группа не привязана к игре;
• common.finder - указанная группа не найдена.