Comment on page
Cordova Inbox
If your application needs information about the push notifications that are previously sent to device by Netmera, you can use
NetmeraInbox class to fetch that information from Netmera.The most common use case for this would be to show the list of notifications inside your application in an inbox-style interface.
NetmeraInbox is the core class providing methods and properties needed for operations on push notifications like fetching push objects or updating push objects' status, but you can not directly initialize a NetmeraInbox instance. You get an instance from SDK, then operate on that instance for future inbox actions. Here is the common workflow to use inbox feature of Netmera.You must first define filtering properties by creating a
NetmeraInboxFilter instance. You determine which push notifications will be included in the fetched list by setting related properties of this NetmeraInboxFilter instance.NetmeraInboxFilter class provides filtering according to the following options:- Inbox Status: Read / Unread / Deleted
- Categories: Categories to which push notifications are belong.
- Including expired push notifications or not.
- Page Size: This is not to filter, but to determine the size of chunks which will be gathered during one request.
import { Netmera, NetmeraInboxFilter } from 'react-native-netmera'
const netmeraInboxFilter = new NetmeraInboxFilter()
//Show Read or Unread notifications
netmeraInboxFilter.status = NetmeraPushStatus.readAndUnread
netmeraInboxFilter.pageSize = 10
netmeraInboxFilter.categories = ["category_1", "category_2"]
netmeraInboxFilter.includeExpiredObjects = false
Now, you can request from Netmera to return the list of push notification objects matching with the filter object using the following code:
fetchInboxUsingFilter() {
let filter: NetmeraInboxFilter = {
status: NetmeraPushStatus.readAndUnread,
pageSize: 20
}
this.netmera.fetchInboxUsingFilter(filter).then(inbox => {
console.log("FetchInbox Success: ");
}).catch(err => {
console.log("FetchInbox Error", err);
});
}
After you get
NetmeraInbox object which contains first page of the push notifications, you can fetch next pages with a very similar code shown above but this time via your NetmeraInbox instance. New pages are collected on already created NetmeraInbox object, therefore you can use same response handling with fetching first page.
NetmeraInbox has a method named hasNextPage for checking whether there exists more pages or not. You can use that method to decide whether you should fetch next page or not, to change your ui to let user know she has got to the end of list, etc.Here is the sample code:
this.netmera.fetchNextPage().catch(inbox => {
console.log("FetchNextPage: ");
}).catch(err => {
console.log("FetchNextPage error: ",err);
});
Push notifications may have 3 different states, which are the followings:
- Unread (NetmeraPushStatus.unread)
- Read (NetmeraPushStatus.read)
- Read or Unread (NetmeraPushStatus.readAndUnread)
- Deleted (NetmeraPushStatus.deleted)
These three states allows you to implement a simple notification inbox interface for your users where they can read messages, mark previously read message as unread, delete messages and restore them again if needed.
You can make transitions among states for push notifications inside inbox using
updateStatus method. Calling this method will start an asynchronous request to update status for given push objects, and given callback will be called upon the result of the request.Here is a sample implementation which deleted the first 5 push objects from inbox:
this.netmera.updatePushStatus(index, length, NetmeraPushStatus.read).then(result => {
console.log("Update Status: ", result);
}).catch(err => {
console.log("Update Error: ", err);
});
You can get total count of push objects according to the status info among the push objects that matches given filter. Count can be get only for one specific status as well as for combined set of status values.
//get count unread push objects
this.netmera.countForStatus(NetmeraPushStatus.unread).then(count => {
console.log("Count: ", count);
}).catch(err => {
console.log(err);
});
Last modified 30d ago