Help

1 min read

Message Inbox

Last Updated - Platform 24.0 - SDK 19.0

The Message Inbox is a base implementation for third party inbox providers to reach their audience with inbox messages.

message inbox 

# Inbox
inbox


# Inbox Message
inbox/message/{id}

Replace id with the message identifier. The inbox deeplink is required for account badges to work; the badge value is set against this deeplink.

Set up

This feature works out of the box for integrations that support it. To set up a custom integration:

  1. Implement an InboxService.
class ProviderInboxService: InboxService { ... }
  1. Inject your custom InboxService in a module.
class ProviderModule: PoqModule {
    func didAddToPlatform() {
        Container.shared.services.inboxService.replace { ProviderInboxService() }
    }
}
  1. Deeplink to inbox within your app or as an Account Content link via the CMS.

The inbox only works for one provider at a time. If you have multiple modules with inbox services then the last registered module will be used for the inbox.

Account Badge

The Account Content screen supports badges set against deeplinks. This feature fetches the latest inbox every time the app enters the foreground to keep the badge up to date. The Account tab shows a badge without a value when any of it's links have a value to indicate to the user that there are updates to view.

The Inbox sets the inbox deeplink badge to the number of unread messages. Inbox links in the Account Content screen must exactly match the inbox deeplink to show this badge.

History

  • 18.1.0 (v23.1): Initial release.