VKWebAppAddToProfile
VKWebAppAddToProfile
открывает окно, в котором пользователь может добавить в свой профиль кнопку вызова мини-приложения.
Пример
bridge.send('VKWebAppAddToProfile', {
ttl: 1666076431
})
.then((data) => {
if (data.visibility) {
// Кнопка добавлена в профиль
}
})
.catch((error) => {
// Ошибка
console.log(error);
});
Платформы
Android, iOS, Mobile Web, Web
Параметры
Поле | Тип | Описание |
---|---|---|
ttl
необязательное | integer | Дата и время отключения кнопки в секундах (Unix Timestamp).
Если в качестве параметра передать 0 , кнопка будет находиться в профиле пользователя, пока он сам её не отключит. |
Результат
Проверить результат можно:
- •
Используя объект
Promise
, который возвращается вызовомbridge.send(...)
. - •
С помощью событий
VKWebAppAddToProfileResult
иVKWebAppAddToProfileFailed
.
Подробнее о проверке результатов при вызовах VK Bridge.
Объект Promise
Если обращение к платформе прошло успешно, управление будет передано в then
-обработчик объекта Promise
. В качестве ответа платформа возвращает объект со следующим полем:
Поле | Тип | Описание |
---|---|---|
visibility | string | Информация о том, кому видна кнопка. Возможные значения:
• all — кнопка видна всем пользователям.
• friends — кнопка видна только друзьям пользователя.
• best_friends — кнопка видна только близким друзьям пользователя. |
Если при обращении к платформе произошла ошибка, управление передаётся в метод catch
. В качестве ответа платформа возвращает объект с информацией об ошибке, общий для всех событий VK Bridge.
События
VKWebAppAddToProfileResult
Сигнализирует, что кнопка добавлена в профиль. В обработчик события на стороне пользователя передаются следующие данные:
{
detail: {
type: "VKWebAppAddToProfileResult",
data: {
visibility: "best_friends"
}
}
}
Передаваемый объект подобен объекту, возвращаемому при успешном выполнении промиса.
VKWebAppAddToProfileFailed
Информирует об ошибке, которая произошла при взаимодействии с платформой.
В обработчик события на стороне пользователя передаётся объект с информацией об ошибке, общий для всех методов VK Bridge.
Пример обработки событий
Смотрите раздел Обработка событий-результатов.