Inbox is a drop-in view controller which contains the read and unread push notifications. Even if the user has not clicked on a notification, it will be present in the Inbox and will be highlighted to signify it is unread status. The title and the look and feel of the view are also customisable. Inbox view controller is added as a child view controller to your own controller. This helps you get the delegate callback in the same controller, which you can further use for navigation to different screens.

SDK Installation

Install using Swift Package Manager

MoEngageInbox is supported through SPM from SDK version 1.2.0. To integrate, use the GitHub url https://github.com/moengage/apple-sdk.git for SDK versions equal and above 9.23.0, or https://github.com/moengage/MoEngage-iOS-SDK.git for other SDK versions link and set the branch as master or required version.

Install using CocoaPod

InformationCocoaPods is being deprecated. MoEngage recommends using Swift Package Manager for all new integrations. For more info on CocoaPods, refer to CocoaPods Integration Guide.

From MoEngage-iOS-SDK version 8.2.0 ,Inbox module is separated from the SDK to a separate module as MoEngageInbox and hence has to be added separately. Integrate MoEngageInbox framework by adding the dependency in the podfile as show below.

pod 'MoEngage-iOS-SDK/Inbox',

Now run pod install to install the framework

Inbox Setup Checklist

Make sure the following items are implemented before using the Inbox Module:

Update the MoEngage-iOS-SDK to version >= 9.0.0
Integrate the MoEngageInbox module of version >= 2.0.0
Implement Notification Service Extension and Integrate MoEngageRichNotifcation(>= 7.0.0).
AppGroupID is set in App Target Capabilities and the same is passed to the SDK.
AppGroupID is set in Notification Service Extension Target Capabilities and the same is passed to the MoEngageRichNotification SDK.

App Group IDMake sure the App Group ID configured for both the App Target and the Notification Service Extension Target are the same.

How to use Inbox?

Import MoEngageInbox in your View Controller.
Create a property - @property(nonatomic, strong) MoEngageInboxViewController *inboxController.

In viewDidLoad, add the below code to fetch MoEngageInboxViewController

MoEngageSDKInbox.sharedInstance.getInboxViewController(withUIConfiguration: nil, withInboxWithControllerDelegate: nil, forAppID: "YOUR Workspace ID") { inboxController in
     self.inboxController = inboxController
}

[[MoEngageSDKInbox sharedInstance] getInboxViewControllerWithUIConfiguration:nil withInboxWithControllerDelegate:nil forAppID:@"YOUR Workspace ID" withCompletionBlock:^(MoEngageInboxViewController * _Nullable) {
            self.inboxController = inboxController;
}];

Push/Present the MoEngageInboxViewController

In order for the SDK to handle the transition, use one of the methods.

MoEngageSDKInbox.sharedInstance.pushInboxViewController(toNavigationController: self.navigationController!, withUIConfiguration: nil)
    
// Present 
MoEngageSDKInbox.sharedInstance.presentInboxViewController(withUIConfiguration: nil)

[[MoEngageSDKInbox sharedInstance] pushInboxViewControllerToNavigationController:navigationController withUIConfiguration:nil withInboxWithControllerDelegate:nil forAppID:@"YOUR Workspace ID"];

// Present
[[MoEngageSDKInbox sharedInstance] presentInboxViewControllerWithUIConfiguration:nil withInboxWithControllerDelegate:nil forAppID:@"YOUR Workspace ID"];

MoEngageInboxViewControllerDelegate Methods

Use MoEngageInboxViewControllerDelegate protocol for getting the callbacks from the Inbox Module:

extension NotificationsViewController: MoEngageInboxViewControllerDelegate {
//Called when inbox cell is selected
func inboxEntryClicked(_ inboxItem: MoEngageInboxEntry) {
     print("Inbox Clicked")
}
    
//Called when inbox item is deleted
func inboxEntryDeleted(_ inboxItem: MoEngageInboxEntry) {
     print("Inbox item deleted")
}

// Called when MoEngageInboxViewController is dismissed after being presented
func inboxViewControllerDismissed() {
     print("Dismissed")
}
}

//Called when inbox cell is selected
- (void)inboxEntryClicked:(MoEngageInboxEntry *)inboxItem {
    NSLog(@"Inbox item Clicked");
}

//Called when inbox item is deleted
- (void)inboxEntryDeleted:(MoEngageInboxEntry *)inboxItem {
    NSLog(@"Inbox item Deleted");
}

// Called when MoEngageInboxViewController is dismissed after being presented
- (void)inboxViewControllerDismissed {
    NSLog(@"Inbox Dismissed");
}

Set MoEngageInboxViewControllerDelegate by passing the delegate as parameter in the below functions.

//Push
MoEngageSDKInbox.sharedInstance.pushInboxViewController(toNavigationController: self.navigationController!, withUIConfiguration: nil, withInboxWithControllerDelegate: self)

//Present
MoEngageSDKInbox.sharedInstance.presentInboxViewController(withUIConfiguration: nil, withInboxWithControllerDelegate: self)
        
//Fetch MoEngageInboxViewController
MoEngageSDKInbox.sharedInstance.getInboxViewController(withUIConfiguration: nil, withInboxWithControllerDelegate: self, forAppID: "YOUR Workspace ID") { inboxController in
     self.inboxController = inboxController
 }

//Push
[[MoEngageSDKInbox sharedInstance] pushInboxViewControllerToNavigationController:navigationController withUIConfiguration:nil withInboxWithControllerDelegate:self forAppID:@"YOUR Workspace ID"];

//Present
[[MoEngageSDKInbox sharedInstance] presentInboxViewControllerWithUIConfiguration:nil withInboxWithControllerDelegate:self forAppID:@"YOUR Workspace ID"];

//Fetch MoEngageInboxViewController
[[MoEngageSDKInbox sharedInstance] getInboxViewControllerWithUIConfiguration:nil withInboxWithControllerDelegate:self forAppID:@"YOUR Workspace ID" withCompletionBlock:^(MoEngageInboxViewController * _Nullable inboxController) {
          self.inboxController = inboxController;
    }];
}

Customizing Appearance

You can push/present your controller. If you push your controller, make sure to add “Done” or “Cancel” button as a UIBarButtonItem to dismiss your View Controller.
You can get the delegate callback of the click action on inbox cells.
You can use this data for tracking events or navigation to another screen.

You can customize the look and feel of the inbox view controller using the method:

let configuration = MoEngageInboxUIConfiguration()
configuration.cellDefaultBackgroundColor = .red
configuration.cellHeaderLabelFont = UIFont.systemFont(ofSize: 15)
configuration.cellMessageLabelFont = UIFont.systemFont(ofSize: 13)
configuration.cellSelectionTintColor = .red
configuration.cellHeaderLabelTextColor = .white
configuration.cellMessageLabelTextColor = .white
configuration.cellUnreadBackgroundColor = .blue
            
let navigationBarStyle = MoEngageInboxNavigationBarStyle()
navigationBarStyle.navigationBarColor = .black
navigationBarStyle.navigationBarTintColor = .blue
navigationBarStyle.navigationBarTitleColor = .blue
navigationBarStyle.navigationBarTransluscent = false
configuration.navigationBarStyle = navigationBarStyle

//Present
MoEngageSDKInbox.sharedInstance.presentInboxViewController(withUIConfiguration: configuration, forAppID: "YOUR Workspace ID")

//Push
MoEngageSDKInbox.sharedInstance.pushInboxViewController(toNavigationController: self.navigationController!, withUIConfiguration: configuration, forAppID: "Workspace ID")

//Fetch MoEngageInboxViewController
MoEngageSDKInbox.sharedInstance.getInboxViewController(withUIConfiguration: configuration, forAppID: "YOUR Workspace ID") { controller in
}

MoEngageInboxUIConfiguration* configuration = [[MoEngageInboxUIConfiguration alloc] init];
configuration.cellDefaultBackgroundColor = [UIColor redColor];
configuration.cellHeaderLabelFont =[UIFont fontWithName:@"AvenirNext-Bold" size:18];
configuration.cellMessageLabelFont = [UIFont fontWithName:@"AvenirNext-Bold" size:15];
configuration.cellHeaderLabelTextColor = [UIColor whiteColor];
configuration.cellMessageLabelTextColor =[UIColor whiteColor];
configuration.cellUnreadBackgroundColor = [UIColor blueColor];
    
MoEngageInboxNavigationBarStyle* navigationBarStyle = [[MoEngageInboxNavigationBarStyle alloc] init];
navigationBarStyle.navigationBarColor = [UIColor blackColor];
navigationBarStyle.navigationBarTintColor = [UIColor blueColor];
navigationBarStyle.navigationBarTitleColor = [UIColor blueColor];
navigationBarStyle.navigationBarTransluscent = true;
configuration.navigationBarStyle = navigationBarStyle;
    
 //Present
[[MoEngageSDKInbox sharedInstance] presentInboxViewControllerWithUIConfiguration:configuration withInboxWithControllerDelegate:self forAppID:@"YOUR Workspace ID"];
    
//Push
[[MoEngageSDKInbox sharedInstance] pushInboxViewControllerToNavigationController:navigationController withUIConfiguration:configuration withInboxWithControllerDelegate:nil forAppID:@"YOUR Workspace ID"];
    
//Fetch MoEngageInboxViewController
[[MoEngageSDKInbox sharedInstance] getInboxViewControllerWithUIConfiguration:configuration withInboxWithControllerDelegate:nil forAppID:@"YOUR Workspace ID" withCompletionBlock:^(MoEngageInboxViewController * _Nullable inboxController) {
}];

Self Handled Inbox

Fetch Inbox Messages:

Inbox can be completely customized now. Use getInboxMessages(forAppID:withCompletionBlock:) to fetch the inbox messages.

MoEngageSDKInbox.sharedInstance.getInboxMessages(forAppID: "YOUR Workspace ID") { inboxMessages, account in
     print("Received Inbox messages")
 }

[[MoEngageSDKInbox sharedInstance] getInboxMessagesForAppID:@"YOUR Workspace ID" withCompletionBlock:^(NSArray * _Nonnull inboxEntry, MoEngageAccountMeta * _Nullable accountMeta) {
            NSLog(@"Received Inbox messages");
}];

Mark a notification as Read:

An inbox notification can be marked as read with the method markInboxNotificationClicked(withCampaignID:forAppID:completionHandler) by providing the campaign ID of the notification while calling the method. The method will return the updated notification payload where the isRead key will be set to true.

//Get the MoEngageInboxEntry instance
let pushModel = inboxMessages[]

if !pushModel.isRead {
    MoEngageSDKInbox.sharedInstance.markInboxNotificationClicked(withCampaignID: pushModel.campaignID)
}

//An example of marking the inbox message as read
MoEngageInboxEntry *pushDataObj = [self.inboxMessagesArray objectAtIndex:<get the index>];

if (!pushDataObj.isRead){
    [[MoEngageSDKInbox sharedInstance] markInboxNotificationClickedWithCampaignID:pushDataObj.campaignID forAppID:nil completionHandler:nil];
  //Rest of the implementation
}

Track Inbox Notification Clicks:

An inbox notification click can be tracked by using method trackInboxClick(withCampaignID:forAppID:) by providing the campaign ID of the notification while calling the method.

//Get the MoEngageInboxEntry instance
 let pushModel = inboxMessages[]
 MoEngageSDKInbox.sharedInstance.trackInboxClick(withCampaignID: pushModel.campaignID)

//An example of marking the inbox message as read
MoEngageInboxEntry *pushDataObj = [self.inboxMessagesArray objectAtIndex:<get the index>];
[[MoEngageSDKInbox sharedInstance] trackInboxClickWithCampaignID:pushDataObj.campaignID forAppID:nil];

Process the Inbox Clicks:

If you want to perform the actions supported by the SDK(i.e, rich landing, deep linking, coupon code etc) associated with the notifications on clicking the entry in Inbox call processInboxNotification(withCampaignID:forAppID:) method as shown below.

//Get the MoEngageInboxEntry instance
 let pushModel = inboxMessages[]
 MoEngageSDKInbox.sharedInstance.processInboxNotification(withCampaignID: pushModel.campaignID)

 //An example of process the notification actions
MoEngageInboxEntry *pushDataObj = [self.inboxMessagesArray objectAtIndex:<get the index>];
[[MoEngageSDKInbox sharedInstance] processInboxNotificationWithCampaignID:pushDataObj.campaignID forAppID:@"YOUR Workspace ID"];

Get Unread Notifications count:

You can obtain the unread notifications count from the Inbox by using getUnreadNotificationCount(forAppID:withCompletionBlock:) method as shown below:

//Get Unread Notifications count 
MoEngageSDKInbox.sharedInstance.getUnreadNotificationCount() { count, accountMeta in
    print("Unread message count is \(count)")
}

//Get Unread Notifications count 
[[MoEngageSDKInbox sharedInstance] getUnreadNotificationCountForAppID:@"YOUR Workspace ID" withCompletionBlock:^(NSInteger count, MoEngageAccountMeta * _Nullable accountMeta) {
        NSLog(@"Fetched unread message Count");
}];

Deleting Messages

Use removeInboxMessages(forAppID:completionHandler:) method to remove all the messages currently stored in inbox.

MoEngageSDKInbox.sharedInstance.removeInboxMessages { success in
                    print("Removed all inbox messages \(success)")
                }

[[MoEngageSDKInbox sharedInstance] removeInboxMessagesForAppID:@"YOUR Workspace ID" completionHandler:^(BOOL) {
        // Add your code
    }];

Use removeInboxMessage(withCampaignID:forAppID:completionHandler:) method to remove the single message stored in inbox by passing the Campaign ID.

MoEngageSDKInbox.sharedInstance.removeInboxMessage(withCampaignID: "YOUR CAMPAIGN ID")

[[MoEngageSDKInbox sharedInstance] removeInboxMessageWithCampaignID:@"CAMPAIGN ID" forAppID:@"YOUR Workspace ID"];

Methods deprecated in SDK version 4.4.0

We have revamped the Inbox Module in the SDK version 4.4.0 and following this, we have deprecated MOInboxPushDataModel class and use MOInboxModel class instances as the model object for notifications. Along with this, we have also deprecated few of the existing methods of MOInbox as listed below:

+(NSArray *)getInboxMessages __deprecated_msg("This method is deprecated as the payload structure has changed, this method will be removed in SDK Version 5.0.0. Use getInboxMessagesWithCompletionBlock: instead");

+(void)trackInboxNotificationClickForCampaign:(MOInboxPushDataModel*)campaignObj andIsFirstClick:(BOOL)isFirstClick __deprecated_msg("This method is deprecated as MOInboxPushDataModel Class is depreacted, this method will be removed in SDK Version 5.0.0. Use trackInboxNotificationClickWithCampaignID: instead");

+(void)processInboxNotificationOnClickForCampaign:(MOInboxPushDataModel*)campaignObj __deprecated_msg("This method is deprecated as MOInboxPushDataModel Class is depreacted, this method will be removed in SDK Version 5.0.0. Use processInboxNotificationWithCampaignID: instead");

+(NSMutableDictionary*)markNotificationReadWithCampaignID:(NSString*)cid __deprecated_msg("This method is deprecated as MOInboxPushDataModel Class is depreacted, this method will be removed in SDK Version 5.0.0. Use markInboxNotificationClickedWithCampaignID: instead");

+(void)writeArrayToFile:(NSMutableArray *)anArray __deprecated_msg("Method Deprecated. From SDK Version 5.0.0 you will not be able to change the inbox file content.");

These methods will be removed from the SDK version 5.0.0; therefore, make sure you have updated all the Inbox features to use the newer APIs.

InformationThe MoEngage SDK only synchronizes push data with the Notification Center when the app is launched for the first time or when it returns to the foreground from the background.

SDKs

iOS Notification Center

SDK Installation

Install using Swift Package Manager

Install using CocoaPod

Inbox Setup Checklist

How to use Inbox?

Push/Present the MoEngageInboxViewController

MoEngageInboxViewControllerDelegate Methods

Customizing Appearance

Self Handled Inbox

Fetch Inbox Messages:

Mark a notification as Read:

Track Inbox Notification Clicks:

Process the Inbox Clicks:

Get Unread Notifications count:

Deleting Messages

Methods deprecated in SDK version 4.4.0

​SDK Installation

​Install using Swift Package Manager

​Install using CocoaPod

​Inbox Setup Checklist

​How to use Inbox?

​Push/Present the MoEngageInboxViewController

​MoEngageInboxViewControllerDelegate Methods

​Customizing Appearance

​Self Handled Inbox

​Fetch Inbox Messages:

​Mark a notification as Read:

​Track Inbox Notification Clicks:

​Process the Inbox Clicks:

​Get Unread Notifications count:

​Deleting Messages

​Methods deprecated in SDK version 4.4.0

SDK Installation

Install using Swift Package Manager

Install using CocoaPod

Inbox Setup Checklist

How to use Inbox?

Push/Present the MoEngageInboxViewController

MoEngageInboxViewControllerDelegate Methods

Customizing Appearance

Self Handled Inbox

Fetch Inbox Messages:

Mark a notification as Read:

Track Inbox Notification Clicks:

Process the Inbox Clicks:

Get Unread Notifications count:

Deleting Messages

Methods deprecated in SDK version 4.4.0