Push Inbox

Push Inbox Overview

NetmeraInbox allows you to access and manage previously sent push notifications in an inbox-style interface. You cannot instantiate NetmeraInbox directly; instead, you must obtain an instance through the SDK and use it to interact with push notifications.

Filtering Notifications

Create a NetmeraInboxFilter instance to specify which push notifications to fetch. You can filter by:

• Status: Read, Unread, or Deleted.

• Categories: Filter by specific categories.

• Expired Notifications: Include or exclude expired notifications.

• Page Size: Number of notifications to fetch per request.

Here is a sample code to determine filtering options:

NetmeraInboxFilter filter = new NetmeraInboxFilter.Builder()
        .pageSize(20) // Default: Integer.MAX_VALUE
        .status(NetmeraPushObject.STATUS_ALL) // Default: NetmeraPushObject.STATUS_READ / NetmeraPushObject.STATUS_UNREAD
        .categories(Arrays.asList("category_1", "category_2")) // Default: null
        .includeExpiredObjects(true) // Default: false
        //create filter object from builder
        .build();

Fetching the First Page

Use Netmera.fetchInbox to retrieve notifications that match the filter:

Netmera.fetchInbox(filter, new NetmeraInbox.NetmeraInboxFetchCallback() {
    @Override 
    public void onFetchInbox(NetmeraInbox netmeraInbox, NetmeraError error) {
        if (error != null) {
            // handle error
            Toast.makeText(context, error.getMessage(), Toast.LENGTH_LONG).show();
            return;
        }
        // Store returned inbox object for future operations
        mInbox = netmeraInbox; // Store inbox object for future use
    }
});

If successful, onFetchInbox will return an inbox object containing push notifications. Otherwise, it will return an error object with failure details.

Filter properties cannot be changed after fetching

To apply new filters, create a new filter object and fetch again:

// Create a new filter and fetch notifications again
NetmeraInboxFilter newFilter = new NetmeraInboxFilter.Builder()
        .status(NetmeraPushObject.STATUS_UNREAD)
        .build();

Netmera.fetchInbox(newFilter, callback);

Fetching Next Pages

Once the first page is retrieved, use mInbox.fetchNextPage() to get additional pages:

if (mInbox.hasNextPage()) {
    mInbox.fetchNextPage(new NetmeraInbox.NetmeraInboxFetchCallback() {
        @Override 
        public void onFetchInbox(NetmeraInbox netmeraInbox, NetmeraError error) {
            // Handle response
        }
    });
}

Calling fetchNextPage() when no additional pages exist will trigger an error.

Updating Push Notification Status

Notifications can have three states:

• Unread

• Read

• Deleted

Use updateStatus to change a notification's status asynchronously:

List<NetmeraPushObject> objectsToDelete = inbox.pushObjects().subList(0, 5);
inbox.updateStatus(objectsToDelete, NetmeraPushObject.STATUS_DELETED,
    new NetmeraInbox.NetmeraInboxStatusCallback() {
        @Override 
        public void onSetStatusInbox(NetmeraError error) {
            if (error != null) {
                // Handle error
            }
        }
});

You can also update the status of all notifications without fetching them:

public static void updateAll(@NetmeraPushObject.InboxStatus final int inboxStatus,
                             final NetmeraInbox.NetmeraInboxStatusCallback callback)

Counting Notifications by Status

Retrieve the count of notifications by status:

inbox.countForStatus(NetmeraPushObject.STATUS_DELETED); // Deleted  
inbox.countForStatus(NetmeraPushObject.STATUS_READ); // Read  
inbox.countForStatus(NetmeraPushObject.STATUS_UNREAD); // Unread  

Handling Push Objects

You can use this method to programmatically trigger the action associated with a push message in the inbox.

Netmera.handlePushObject(activity, pushObject);

• activity: The current Activity context.

• pushObject: The NetmeraPushObject instance representing the push message whose action you want to trigger.

Message Categories

The per-channel message category preference APIs described in this section require Netmera Android SDK 4.21.0 or later.

Create message categories from Settings > Messaging & Content > Message Categories in the panel. Each category can be managed per channel (Mobile Push, SMS, Email, WhatsApp, In-App, Web) — so you can track and update a user's opt-in status either for the category as a whole or for one specific channel.

Channels are represented by the NMCategoryChannel enum:

enum class NMCategoryChannel {
    MOBILE, SMS, EMAIL, WHATS_APP, IN_APP, WEB
}

Getting a User's Category Preferences

Fetch the full list of category preferences (ID, name, and opt-in status):

Netmera.getUserCategoryPreferenceList(object : NMCategoryPreferenceFetchCallback {
    override fun onSuccess(categoryPreferenceList: MutableList<NMCategoryPreference>) {
        // handle category preference list
    }

    override fun onFailure(error: String?) {
        // handle error
    }
})

To narrow the result down, pass an NMCategoryPreferenceFilter with a list of category IDs, channels, or both. A category that doesn't support any of the requested channels is left out of the result.

val filter = NMCategoryPreferenceFilter(
    categoryIds = listOf(42, 43),
    channels = listOf(NMCategoryChannel.SMS, NMCategoryChannel.EMAIL)
)

Netmera.getUserCategoryPreferenceList(filter, object : NMCategoryPreferenceFetchCallback {
    override fun onSuccess(categoryPreferenceList: MutableList<NMCategoryPreference>) {
        categoryPreferenceList.forEach { category ->
            // Aggregate opt-in status, same as before, regardless of the channel filter
            println("${category.categoryId} - ${category.categoryName} -> ${category.optInStatus}")

            // Per-channel breakdown
            category.channelPreferences?.forEach { channelPreference ->
                println("  ${channelPreference.channel}: ${channelPreference.optInStatus}")
            }
        }
    }

    override fun onFailure(error: String?) {
        // handle error
    }
})

You can also filter by a single category or channel:

NMCategoryPreferenceFilter(categoryId = 42)
NMCategoryPreferenceFilter(channel = NMCategoryChannel.SMS)
NMCategoryPreferenceFilter(categoryId = 42, channel = NMCategoryChannel.SMS)

Each NMCategoryPreference includes:

• optInStatus — the overall status: true if the category is enabled on any channel. This is always returned, regardless of channel filters.

• channelPreferences — a per-channel breakdown, as a list of NMCategoryChannelPreference (channel, optInStatus).

Updating Category Preferences

To turn a category on or off, pass an NMCategoryPreferenceUpdate with the category ID and the new categoryEnabled value:

val preference = NMCategoryPreferenceUpdate(categoryId = 42, categoryEnabled = true)

Netmera.setUserCategoryPreference(preference, object : NMCategoryPreferenceSetCallback {
    override fun onSuccess() {
        // handle success
    }

    override fun onFailure(error: String?) {
        // handle failure
    }
})

To update just one channel instead of the whole category, add a channel:

val channelPreference = NMCategoryPreferenceUpdate(
    categoryId = 42,
    categoryEnabled = false,
    channel = NMCategoryChannel.SMS
)

Netmera.setUserCategoryPreference(channelPreference, object : NMCategoryPreferenceSetCallback {
    override fun onSuccess() {
        // handle success
    }

    override fun onFailure(error: String?) {
        // handle failure
    }
})

Note: The older Netmera.setUserCategoryPreference(categoryId, categoryEnabled, listener) method still works but is deprecated. It behaves the same as calling the new method without a channel.