Web Push SDK

Web Push SDK — это JavaScript-инструментарий для подключения web push-уведомлений на сайте и управления push-подписками пользователей через платформу Altcraft.

SDK используется как связующее звено между сайтом, браузером пользователя и платформой. С его помощью сайт может вызвать системное окно подписки браузера, зарегистрировать push-подписку, передать данные пользователя в профиль, обновить статус подписки и обработать события, связанные с push-уведомлениями.

Web Push SDK применяется в тех случаях, когда нужно:

• подключить web push-уведомления на сайт;
• показывать пользователю запрос на подписку;
• создавать и обновлять push-подписки;
• связывать подписку с профилем в базе;
• передавать в профиль дополнительные данные пользователя;
• приостанавливать подписку;
• отслеживать события подписки и изменения токена браузера.

Что дальше?

Чтобы начать работу с Web Push SDK, перейдите в раздел пользовательской документации по Web Push. Там содержатся подробные настройки по созданию ресурса и подключению SDK на сайт.

Методы Web Push SDK

Полный список методов и их параметров можно посмотреть ниже.

Список методов

initSubscription

Метод инициализирует подписку. Используется для записи данных клиента в профиль и выполнения поиска среди существующих профилей.

Параметры

Параметр	Тип	Обязательный	Описание
match	object	Да	Определяет матчинг профиля. Если не будет передана база профилей для поиска, платформа будет искать профиль в привязанных к ресурсу базах.
update	object	Нет	Содержит данные для внесения в новый или существующий профиль

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

const akPush = new AKPush();
AKPush.initSubscription(
	{           
		db: 1                   
		email: 'example@email.com'
	},
	{
		_fname: 'Anatoly',
		_lname: 'Wasserman'
	}
)

---

updateSubscription

Метод для обновления данных профиля и изменения статуса push-подписок.

Параметры

Параметр	Тип	Обязательный	Описание
match	object	Да	Определяет матчинг профиля. Если не будет передана база профилей для поиска, платформа будет искать профиль в привязанных к ресурсу базах.
update	object	Нет	Содержит данные для внесения в новый или существующий профиль. Если необходимо передать параметр inexclusive без обновления данных профиля, нужно указать в update пустой объект .
inexclusive	boolean	Нет	Если флаг inexclusive не передан или равен false: Если фильтр баз не указан, то в каждой базе ресурса будет только один профиль с одной подпиской на актуальный токен со статусом "Подписан". Если фильтр указан, то в каждой из заданных баз будет только один профиль с одной подпиской на актуальный токен со статусом подписан. В остальных базах будут приостановлены совпадающие подписки. Если флаг равен true, вызов эквивалентен initSubscription.

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

const akPush = new AKPush();
AKPush.updateSubscription(
	{           
		db: [15,20]                 
		email: 'example@email.com'
	},
	{
		_fname: 'Anatoly',
		_lname: 'Wasserman'
	},
	false
)

---

AKPush.events.on

Метод для подписки на события, связанные с push-уведомлениями.

Параметры

Параметр	Тип	Обязательный	Описание
subscribe update_subscription suspend_subscription	string	Да	Название события
callback	function	Да	Функция, вызываемая при событии. Для subscribe: { browser: "<браузер>", provider: "<провайдер>", token: "<токен>" } Для update_subscription и suspend_subscription: { browser: "<браузер>", provider: "<провайдер>", token: "<токен>", tokenCached: "<кэшированный токен>" }

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

AKPush.events.on('subscribe', (data) => {
   console.log(data);
});
AKPush.events.on('update_subscription', (data) => {
   console.log(data);
});

---

suspendSubscription

Метод приостанавливает подписку пользователя на push-уведомления.

Параметры

Параметр	Тип	Обязательный	Описание
match	object	Да	Определяет матчинг профиля.
update	object	Нет	Содержит данные для обновления профиля

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

const akPush = new AKPush();
AKPush.suspendSubscription(
	{           
		db: 1                   
		email: 'example@email.com'
	},
	{
		_status: 'inactive'
	}
)

---

AKPush.removeToken

Метод удаляет токен устройства из кэша. Параметры не требуются.

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

AKPush.removeToken()