Настройка папки входящих сообщений для веба

Предварительные требования

Убедитесь, что вы установили Pushwoosh Web SDK на свой сайт. Для этого следуйте нашему руководству.

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

Как это работает

Вот типичный рабочий процесс с InboxMessages:

Шаг	Метод
Загрузка страницы
Синхронизация сообщений с сервером	`InboxMessagesModel.updateMessages` Выполняется при инициализации SDK
Удаление устаревших сообщений	`InboxMessagesModel.updateMessages` Выполняется при инициализации SDK
Получение количества непрочитанных сообщений для обновления значка	`Pushwoosh.pwinbox.unreadMessagesCount` Выполняется вручную (после срабатывания события `onUpdateInboxMessages`)
Загрузка сообщений для отображения в папке входящих	`Pushwoosh.pwinbox.loadMessages` Выполняется вручную (после срабатывания события `onUpdateInboxMessages`)
Пометка сообщений, попавших в область просмотра, как прочитанных	`Pushwoosh.pwinbox.readMessagesWithCodes` Выполняется вручную
Выполнение действия, назначенного открытому сообщению	`Pushwoosh.pwinbox.performActionForMessageWithCode` Выполняется вручную
Удаление сообщений по клику на иконку удаления или свайпу вправо	`Pushwoosh.pwinbox.performActionForMessageWithCode` Выполняется вручную

Слушатели событий

// Выполняется после автоматического обновления папки входящих сообщений во время загрузки страницы.
Pushwoosh.push(['onUpdateInboxMessages', function(api, pwinbox) {
  pwinbox.loadMessages().then(function(messages) {
    console.log('EVENT: onUpdateInboxMessages', messages);
  });
}]);

// Выполняется ServiceWorker'ом после получения входящего сообщения и его сохранения в indexedDB.
Pushwoosh.push(['onPutNewMessageToInboxStore', function(api, message) {
  console.log('EVENT: onPutNewMessageToInboxStore', message);
}]);

Публичный модуль

Публичный модуль WebSDK InboxMessagesPublic представляет собой публичный интерфейс для реализации веб-папки входящих сообщений.

type TInboxMessageTypePlain = 0;
type TInboxMessageTypeRichmedia = 1;
type TInboxMessageTypeURL = 2;
type TInboxMessageTypeDeeplink = 3;
type TInboxMessageType = TInboxMessageTypePlain  // зависит от action_params
  | TInboxMessageTypeRichmedia
  | TInboxMessageTypeURL
  | TInboxMessageTypeDeeplink;


interface IInboxMessagePublic {
  code: string;  // inbox_id
  title: string;  // title
  message: string; // body
  imageUrl: string;  // image
  sendDate: string;  // send_date
  type: TInboxMessageType;  // зависит от action_params
  isRead: boolean;  // true, если статус "read" или "open"
  link: string; // Deeplink | URL | "/"
  isActionPerformed: boolean;  // true, если статус "open"
}

Публичные методы

Ознакомьтесь с описаниями публичных методов в руководстве по Web Push SDK 3.0.