Общая информация

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

В отличие от showNotification не допускает отправки приглашений пользователям, которые уже используют это приложение.

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

FAPI.UI.showInvite(text, params, selected_uids);
ПараметрОбязателенОписание
textДаТекст, который будет отправлен в приглашении
paramsНетКастомные данные, передаваемые приложению, когда пользователь принимает приглашение. Данные будут переданы в параметре «custom_args», подробную информацию см. в разделе Параметры приложения.
Максимальная длина: 120 символов.
selected_uidsНетСписок идентификаторов друзей, которые будут уже выбраны при открытии окна приглашения.
Максимум 5 ID за запрос.
Пользователи должны быть в списке друзей, выделяются только те пользователи, которые играли в последнее время в игры.

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

/*
* Пример использования диалога приглашения друзей
*/
function showInvite() {
    FAPI.UI.showInvite("Поиграй в мою игру!", "arg1=val1");
    // в случае успеха возвращает в API_callback третьим параметром строку, в которой через запятую указаны id приглашенных друзей
}

Пример с использованием selected_uids

/*
* Пример использования диалога приглашения друзей с предварительным выделением
*/
function showInvite2() {
    var callback = function(status, result, data) {
        if(result.length > 0) {
            FAPI.UI.showInvite("Поиграй в мою игру!", "arg1=val1", result[0]);
            // в случае успеха возвращает в API_callback третьим параметром строку, в которой через запятую указаны id приглашенных друзей
        } else {
            alert("Не хватает друзей для примера");
        }
    }
    FAPI.Client.call({"method":"friends.get"}, callback);
}

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

В зависимости от действия пользователя в диалоге приглашения функция API_callback может быть вызвана со следующими параметрами:

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

Веб-версия

method: “showInvite”

result: “cancel”

data: “null”

Мобильная версия

method: “showInvite”

result: “error”

data: “cancel”

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

method: “showInvite”

result: “ok”

data: “1234567890”

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

method: “showInvite”

result: “ok”

data: “1234567890,1234567891”

Коллбек для случая, когда не было найдено пользователей для инвайта (mobile only)

method: “showInvite”

result: “error”

data: “noUsers”

Пример диалога приглашения

В результате выполнения функции пользователю будет показан диалог для выбора и отправки приглашений в игру друзьям:

Пример диалога для веб-версии приложения

Пример диалога для мобильной версии приложения