Skip to main content

Documentation Index

Fetch the complete documentation index at: https://moengage-ios-release-notes-breaking-changes-doc-1961.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Real-time device triggers are push notifications that are triggered instantly in the device whenever a trigger event(configured while creating the campaign) is tracked with the SDK trackEvent: method. In this case, the notifications are triggered in the device, which enables you to post notifications even in offline scenarios.
NoteReal-Time Triggers are available from SDK version 4.0.0

​
SDK Installation

MoEngageRealTimeTrigger 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, MoEngageRealTimeTrigger module is separated from the SDK to a separate module as MoEngageRealTimeTrigger and hence has to be added separately. Integrate the RealTimeTrigger framework by adding the dependency in the podfile as shown below. 
pod 'MoEngage-iOS-SDK/RealTimeTrigger',
Now run pod install to install the framework

​
Manual Syncing

MoEngage SDK syncs all the real-time trigger campaigns whenever the app is launched OR comes to the foreground. But in case its needed to manually sync the device triggers for any of the background tasks, use syncRealTimeTriggers(forAppID:andCompletionHandler:) as shown below: 
MoEngageSDKRealTimeTrigger.sharedInstance.syncRealTimeTriggers { (rtSyncCompleted) in
          if(rtSyncCompleted){
             print("Real-Time trigger sync successfull")
      }
}

​
Additional Callbacks for version below iOS 10

NoteFor iOS 10 and above, MoEngage SDK uses the UserNotification framework for triggering notifications and relies on the callbacks from UNUserNotificationCenter to obtain and process the notification payload. Therefore, make sure the SDK methods are called in UNUserNotificationCenter delegate callbacks as mentioned in this doc.
For iOS versions below iOS 10 call didReceieveNotificationinApplication: withInfo:openDeeplinkUrlAutomatically: method of MoEngage SDK as shown below. 
func application(_ application: UIApplication, didReceive notification: UILocalNotification) {
        if let userInfo = notification.userInfo  {
            MoEngage.sharedInstance().didReceieveNotificationinApplication(application, withInfo: userInfo, openDeeplinkUrlAutomatically: true)
        }
}