Configurar a caixa de entrada de mensagens da web

Pré-requisitos

Certifique-se de que implementou o SDK da Web da Pushwoosh em seu site. Para fazer isso, siga nosso guia.

A Caixa de Entrada de Mensagens para sites permite que você armazene notificações push da web para que os usuários possam revisitá-las mais tarde, garantindo que mensagens importantes sejam vistas.

Como funciona

Aqui está um fluxo de trabalho típico com InboxMessages:

Etapa	Método
Carregamento da página
Sincronizando mensagens com o servidor	`InboxMessagesModel.updateMessages` Executado enquanto o SDK é inicializado
Excluindo mensagens desatualizadas	`InboxMessagesModel.updateMessages` Executado enquanto o SDK é inicializado
Recebendo o número de mensagens não lidas para atualizar um selo	`Pushwoosh.pwinbox.unreadMessagesCount` Executado manualmente (após o evento `onUpdateInboxMessages` ser acionado)
Carregando mensagens para serem exibidas na Caixa de Entrada	`Pushwoosh.pwinbox.loadMessages` Executado manualmente (após o evento `onUpdateInboxMessages` ser acionado)
Marcando mensagens que entraram na viewport como lidas	`Pushwoosh.pwinbox.readMessagesWithCodes` Executado manualmente
Executando uma ação atribuída à mensagem aberta	`Pushwoosh.pwinbox.performActionForMessageWithCode` Executado manualmente
Excluindo mensagens ao clicar em um ícone de exclusão ou deslizar uma mensagem para a direita	`Pushwoosh.pwinbox.performActionForMessageWithCode` Executado manualmente

Ouvintes de eventos

// Executado após a Caixa de Entrada ser atualizada automaticamente durante o carregamento da página.
Pushwoosh.push(['onUpdateInboxMessages', function(api, pwinbox) {
  pwinbox.loadMessages().then(function(messages) {
    console.log('EVENT: onUpdateInboxMessages', messages);
  });
}]);

// Executado pelo ServiceWorker após a Mensagem da Caixa de Entrada ser recebida e salva no indexedDB.
Pushwoosh.push(['onPutNewMessageToInboxStore', function(api, message) {
  console.log('EVENT: onPutNewMessageToInboxStore', message);
}]);

Módulo público

O módulo WebSDK InboxMessagesPublic apresenta uma interface pública para implementar a Caixa de Entrada da Web.

type TInboxMessageTypePlain = 0;
type TInboxMessageTypeRichmedia = 1;
type TInboxMessageTypeURL = 2;
type TInboxMessageTypeDeeplink = 3;
type TInboxMessageType = TInboxMessageTypePlain  // depends on 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;  // depends on action_params
  isRead: boolean;  // true if status is "read" or "open"
  link: string; // Deeplink | URL | "/"
  isActionPerformed: boolean;  // true if status is "open"
}

Métodos públicos

Confira as descrições dos métodos públicos no guia do SDK da Web Push 3.0.