BatchInboxFetcher class abstract

BatchInboxFetcher allows you to fetch notifications that have been sent to a user (or installation, more on that later) in their raw form, allowing you to display them in a list, for example. This is also useful to display messages to users who disabled notifications.

Once you get your BatchInboxFetcher instance, you should call fetchNewNotifications to fetch the initial page of messages: nothing is done automatically. This method is also useful to refresh the list from the beginning, like in a "pull to refresh" scenario.

In an effort to minimize network and memory usage, messages are fetched by page (batches of messages): this allows you to easily create an infinite list, loading more messages on demand.

While you can configure the maximum number of messages you want in a page, the actual number of returned messages can differ, as the SDK may filter some of the messages returned by the server (such as duplicate notifications, etc...).

Please MAKE SURE to call BatchInboxFetcher.dispose once you're done with the fetcher (for example, when the user navigates away). This should usually be done in your State's dispose method. Failure to do so will leak memory, as Batch will not know that the associated native object can be released, and the message channel freed.

As BatchInboxFetcher caches answers from the server, instances of this class should be tied to the lifecycle of the UI consuming it (if applicable).

Another reason to keep the object around, is that you cannot mark a message as read with another BatchInboxFetcher instance that the one that gave you the message in the first place, as this relies on internal data structures that are only loaded in memory.

You can also set a upper messages limit, after which BatchInbox will stop fetching new messages, even if you call fetchNextPage.