Message Center for the Capacitor Plugin

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

Display the Message Center

Display the Message Center with a single method call:

await 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:

const messages = await Airship.messageCenter.getMessages()

Listen for Message Updates

Subscribe to message updates using event listeners:

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

Listen for Unread Count Changes

Subscribe to unread count updates:

const unreadCount = await Airship.messageCenter.getUnreadCount();
// Update badge or UI

Refresh Messages

Manually refresh the message list from the server:

await Airship.messageCenter.refreshMessages()

Mark Messages as Read

Mark one or more messages as read:

await Airship.messageCenter.markMessageRead("message-id")

Delete Messages

Delete one or more messages:

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