Сигнатура метода
Метод предназначен для вступления пользователем в группу, привязанную к приложению в его настройках.
Также метод автоматически разрешает отправлять от лица группы сообщения пользователю через Bot API независимо от того, является ли пользователь участником группы или нет.
FAPI.invokeUIMethod("joinGroup", groupId);Пример вызова
/*
* Функция инициирует вступление в группу и/или запрос разрешения на отправку ему сообщений
*/
function joinGroup() {
FAPI.invokeUIMethod("joinGroup", 123312123);
}Рекомендации по использованию метода
Перед вызовом метода рекомендуется проверять текущий статус пользователя:
- является ли пользователь участником группы - метод group.getUserGroupsV2;
- разрешил ли пользователь сообщения от группы - метод group.isMessagesAllowed.
Также обратите внимание, чтобы ваша группа соответствовала следующим условиям:
- группа должна быть открытой;
- группа не должна иметь ограничение по возрасту пользователей;
- группа должна быть привязана к игре в настройках игры;
- если вы планируете отправлять сообщения от группы пользователям, то групповые сообщения также должны быть включены в настройках группы (подробнее о групповых сообщениях)
Пример коллбека
В результате выполнения метода вызывается клиентский коллбек, в котором передается результат его выполнения.
Коллбек при успешном вызове метода
method: “joinGroup”
result: “ok”
data: “ready”
Коллбек при ошибке выполнения метода / отмене вызова
method: “joinGroup”
result: “error”
data: errorCode
Коды ошибок
При возникновении ошибки в поле data коллбека возвращается код ошибки, который однозначно определяет причину этой ошибки:
- cancel - пользователь отменил вступление в группу;
- already.member - пользователь уже является участником группы;
- group.access.denied - группа не привязана к игре;
- common.finder - указанная группа не найдена.