Message Center

Message Center provides an inbox for rich, HTML-based messages. Learn more about Message Center in our feature guide.

Display the Message Center

Display the Message Center with a single method call:

Airship.messageCenter.display();

To build a custom message list, see Embedding the Message Center. Individual messages will still display as a native overlay.

Fetch Messages

Retrieve messages from the inbox:

Airship.messageCenter.getMessages((messages) => {
  console.log('Inbox messages: ' + messages);
});

Listen for Message Updates

Subscribe to message updates using event listeners:

Airship.addListener('messageCenterUpdated', () => {
  Airship.messageCenter.getMessages((messages) => {
    // Handle messages
  });
});

Listen for Unread Count Changes

Subscribe to unread count updates:

Airship.messageCenter.getUnreadCount((unreadCount) => {
  // Update badge or UI
});

Refresh Messages

Manually refresh the message list from the server:

Airship.messageCenter.refreshMessages(
  () => {
    console.log('Refreshed');
  },
  (error) => {
    console.log('Failed: ' + error);
  }
);

Mark Messages as Read

Mark one or more messages as read:

Airship.messageCenter.markRead("message-id");

Delete Messages

Delete one or more messages:

Airship.messageCenter.deleteMessage("message-id");