🚧
SDK versions < 6.0.0
Inbox class is named Inbox.

Inbox object

📦 INInbox
 ├── domainInbox : NSString * (readonly)
 ├── lastAccess : NSString *
 ├── notifications : NSArray<INInboxNotification *> *
 ├── count : int
 ├── pageSize : NSNumber *
 ├── page : NSNumber *
 └── totalPages : float


📦 INInboxNotification
 ├── idInboxNotification : NSString *
 ├── externalId : NSString *
 ├── sentAt : NSString *
 ├── inboxStatus : INInboxStatus *
 ├── sendingId : NSNumber *
 ├── campaignId : NSNumber *
 ├── message : INInboxPush *
 ├── replacements : NSString *
 ├── read : Boolean
 └── category : INInboxCategory *


📦 INInboxPush
 ├── pushId : long
 ├── appKey : NSString *
 ├── title : NSString *
 ├── body : NSString *
 ├── image : NSString *
 ├── gif : NSString *
 ├── data : NSString *
 ├── action : INPushAction *
 ├── buttons : NSArray<INPushButton *> *
 ├── securedData : NSString *
 ├── sendingId : NSString *
 ├── campaignId : NSString *
 ├── contentState : NSDictionary *
 ├── clickedButton : int
 ├── journeyStateId : int
 ├── sendEventAck : BOOL
 ├── applicationId : int
 ├── jsonPush : NSDictionary *
 └── eventAt : NSString *

Once the device has been successfully registered, you can start making Inbox requests. The following characteristics of the Inbox must be taken into account, which are optionally configurable.

Inbox Properties
The notifications of the Inbox will have the following states of the class InboxStatus:

Sent : The notification has been sent to the client, whether or not they could read it.
Click: have clicked on the notification displayed in the Inbox.
Delete: The Inbox notification has been deleted by the customer.

The notifications will also come with a 'read' status, to help differentiate those status.

Each notification will be assigned with an integer and unique sendingId, to be able to differentiate them and use them for some of the functionalities.

Get notifications
As explained above, to obtain the notifications the following method is used:

INInbox.getInboxWithSuccess({ (inbox) in
  //DO SOMETHING
}) { (error) in
   //LOG ERROR
}

[INInbox getInboxWithSuccess:^(INInbox * _Nonnull inbox) {
    //DO SOMETHING
} onError:^(INError * _Nonnull error) {
    //LOG ERROR
}];

Inbox next page

Once the Inbox instance is obtained, we will use it to request the next page, which is made with the following method, in the event that there are no more pages it will indicate it in the error with code 410:

inbox.getNextPage(success: { (inbox, newNotifications) in
    //DO SOMETHING
}) { (error) in
    if (error.statusCode == 3011){
        //LOG NO MORE PAGES
    }else{
        //LOG ERROR
    }
}

[inbox getNextPageWithSuccess:^(INInbox * _Nonnull inbox, NSArray<INInboxNotification *>* newNotifications) {
    //DO SOMETHING
} onError:^(INError * _Nonnull error) {
    if (error.statusCode == 410){
        //LOG NO MORE PAGES
    }
    //LOG ERROR
}];

Take into account that the Inbox callback, apart from returning the updated Inbox, returns an array called newNotifications , in which the new notifications to be added to the Inbox will be displayed, so that, if necessary, be able to use said array to move between the pages without depending on the Inbox calls.

Inbox info errors

List of all possible errors from inApp, and messages from callbacks:

INBOX_GET_ERROR = 3001 -> "get Inbox error"
INBOX_EXTERNAL_ID_NO_REGISTERED = 3003 -> "External Id not registered"
INBOX_IS_REQUESTING_PAGE = 3006 -> "Wait. Is Requesting new page"
INBOX_GET_PAGE_ERROR = 3011 -> "There are no more messages on Inbox"
INBOX_GENERAL_ERROR = 3600 -> "inbox general error"
INBOX_BAD_REQUEST = 3604 -> "AppKey or deviceId null or empty"