Inboxは、既読および未読のプッシュ通知を含むドロップインのビューコントローラーです。ユーザーが通知をクリックしていない場合でも、通知はInboxに表示され、未読状態であることを示すためにハイライトされます。ビューのタイトルやルックアンドフィールもカスタマイズできます。 Inboxビューコントローラーは、独自のコントローラーに子ビューコントローラーとして追加されます。これにより、同じコントローラーでデリゲートのコールバックを受け取ることができ、それをさらに別の画面へのナビゲーションに利用できます。

SDKのインストール

Swift Package Managerを使用したインストール

MoEngageInboxは、SDKバージョン1.2.0からSPMでサポートされています。統合するには、SDKバージョン9.23.0以上の場合はGitHubのURL https://github.com/moengage/apple-sdk.git を、その他のSDKバージョンの場合は https://github.com/moengage/MoEngage-iOS-SDK.git を使用し、ブランチをmasterまたは必要なバージョンに設定します。

CocoaPodを使用したインストール

情報CocoaPodsは非推奨になりつつあります。MoEngageでは、すべての新規統合にSwift Package Managerを使用することを推奨しています。CocoaPodsの詳細については、CocoaPods統合ガイドを参照してください。

MoEngage-iOS-SDKバージョン8.2.0から、InboxモジュールはSDKから分離され、MoEngageInboxという別のモジュールになりました。そのため、個別に追加する必要があります。以下に示すように、Podfileに依存関係を追加してMoEngageInboxフレームワークを統合します。

pod 'MoEngage-iOS-SDK/Inbox',

次に、pod install を実行してフレームワークをインストールします。

Inboxセットアップのチェックリスト

Inboxモジュールを使用する前に、以下の項目が実装されていることを確認してください。

MoEngage-iOS-SDKをバージョン >= 9.0.0 に更新します。
バージョン >= 2.0.0 のMoEngageInboxモジュールを統合します。
Notification Service Extensionを実装し、MoEngageRichNotifcation(>= 7.0.0)を統合します。
App Target のCapabilitiesでAppGroupIDが設定され、同じIDがSDKに渡されていること。
Notification Service Extension Target のCapabilitiesでAppGroupIDが設定され、同じIDがMoEngageRichNotification SDKに渡されていること。

App Group IDApp Target と Notification Service Extension Target の両方に設定されたApp Group IDが同じであることを確認してください。

Inboxの使用方法

View Controllerで MoEngageInbox をインポートします。
プロパティを作成します - @property(nonatomic, strong) MoEngageInboxViewController *inboxController.

viewDidLoadに以下のコードを追加して、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;
}];

MoEngageInboxViewControllerのPush/Present

SDKに画面遷移を処理させるには、次のいずれかのメソッドを使用します。

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のメソッド

Inboxモジュールからコールバックを受け取るには、MoEngageInboxViewControllerDelegateプロトコルを使用します。

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");
}

以下の関数でデリゲートをパラメーターとして渡して、MoEngageInboxViewControllerDelegateを設定します。

//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;
    }];
}

外観のカスタマイズ

コントローラーをpush/presentできます。コントローラーをpushする場合は、View Controllerを閉じるために「Done」または「Cancel」ボタンをUIBarButtonItemとして追加してください。
Inboxのセルに対するクリックアクションのデリゲートコールバックを受け取ることができます。
このデータは、イベントのトラッキングや別の画面へのナビゲーションに使用できます。

次のメソッドを使用して、Inboxビューコントローラーのルックアンドフィールをカスタマイズできます。

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: "YOUR_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) {
}];

自己処理型Inbox

Inboxメッセージの取得:

Inboxを完全にカスタマイズできるようになりました。Inboxメッセージを取得するには、getInboxMessages(forAppID:withCompletionBlock:)を使用します。

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");
}];

通知を既読にする:

メソッドの呼び出し時に通知のキャンペーンIDを指定することで、markInboxNotificationClicked(withCampaignID:forAppID:completionHandler)メソッドを使用してInbox通知を既読にできます。このメソッドは、isRead キーが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
}

Inbox通知のクリックのトラッキング:

メソッドの呼び出し時に通知のキャンペーンIDを指定することで、trackInboxClick(withCampaignID:forAppID:)メソッドを使用してInbox通知のクリックをトラッキングできます。

//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];

Inboxのクリックの処理:

Inboxのエントリーをクリックしたときに、通知に関連付けられたSDKがサポートするアクション(リッチランディング、ディープリンク、クーポンコードなど)を実行する場合は、以下に示すようにprocessInboxNotification(withCampaignID:forAppID:)メソッドを呼び出します。

//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"];

未読通知数の取得:

以下に示すように、getUnreadNotificationCount(forAppID:withCompletionBlock:)メソッドを使用して、Inboxから未読通知数を取得できます。

//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");
}];

メッセージの削除

Inboxに現在保存されているすべてのメッセージを削除するには、removeInboxMessages(forAppID:completionHandler:)メソッドを使用します。

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

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

キャンペーンIDを渡してInboxに保存されている単一のメッセージを削除するには、removeInboxMessage(withCampaignID:forAppID:completionHandler:)メソッドを使用します。

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

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

SDKバージョン4.4.0で非推奨になったメソッド

SDKバージョン4.4.0でInboxモジュールを刷新しました。これに伴い、MOInboxPushDataModel クラスを非推奨とし、通知のモデルオブジェクトとして MOInboxModel クラスのインスタンスを使用するようにしました。また、以下に示すように、MOInbox の既存のメソッドの一部も非推奨になりました。

+(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.");

これらのメソッドはSDKバージョン5.0.0で削除されるため、すべてのInbox機能が新しいAPIを使用するように更新されていることを確認してください。

情報MoEngage SDKは、アプリが初めて起動されたとき、またはバックグラウンドからフォアグラウンドに戻ったときにのみ、プッシュデータを通知センターと同期します。

​SDKのインストール

​Swift Package Managerを使用したインストール

​CocoaPodを使用したインストール

​Inboxセットアップのチェックリスト

​Inboxの使用方法

​MoEngageInboxViewControllerのPush/Present

​MoEngageInboxViewControllerDelegateのメソッド

​外観のカスタマイズ

​自己処理型Inbox

​Inboxメッセージの取得:

​通知を既読にする:

​Inbox通知のクリックのトラッキング:

​Inboxのクリックの処理:

​未読通知数の取得:

​メッセージの削除

​SDKバージョン4.4.0で非推奨になったメソッド

SDKのインストール

Swift Package Managerを使用したインストール

CocoaPodを使用したインストール

Inboxセットアップのチェックリスト

Inboxの使用方法

MoEngageInboxViewControllerのPush/Present

MoEngageInboxViewControllerDelegateのメソッド

外観のカスタマイズ

自己処理型Inbox

Inboxメッセージの取得:

通知を既読にする:

Inbox通知のクリックのトラッキング:

Inboxのクリックの処理:

未読通知数の取得:

メッセージの削除

SDKバージョン4.4.0で非推奨になったメソッド