Migrate To The Extension Integrator Tool

Migrate from a manual iOS notification extension setup to the MoEngage Extension Integrator Tool in your React Native app.

All steps in this guide are performed in Xcode. Open your iOS project before proceeding: ios/YourApp.xcworkspace if you use CocoaPods, or ios/YourApp.xcodeproj if you use Swift Package Manager.

To migrate from an existing manual implementation to the integrator tool, follow the below steps:

Step 1: Prerequisites

Before proceeding, ensure the following are in place:

• Ensure you are using MoEngage React Native SDK version 12.6.0 or above to utilize the extension integrator tool.
• SDK initialization: Initialize the MoEngage SDK using file-based initialization.
  • App Group configuration: Provide the AppGroupName key (for example, group.com.organization.app) you are using with your sdkConfig.appGroupID.
• After integration is complete, you may be prompted to access the keychain for code signing. Click Always Allow.
  

Step 2: Integrate MoEngageRichNotification

Integrate MoEngageRichNotification if you need to support either of the following push notification features:

• Rich media — display images, GIFs, or video in the notification banner
• Rich push templates — render interactive notification layouts such as carousel

This step is mandatory if you have integrated the content extension.

Swift Package Manager (SPM)

If your React Native application uses Swift Package Manager, skip this step. react-native-moengage already includes MoEngageRichNotification when you run npx react-native spm. Don’t add the apple-sdk package separately, because Xcode fails to resolve packages when its version differs from the one the plugin uses.

Add MoEngageRichNotification yourself only if you maintain your own Notification Service Extension or Content Extension code that imports it. In that case, add https://github.com/moengage/apple-sdk.git with Dependency Rule set to Exact Version. Use the apple-sdk version that Xcode lists under Package Dependencies, and update it every time you upgrade the MoEngage React Native packages.

To migrate an existing CocoaPods integration to SPM, refer to Migrate From CocoaPods to SPM.

CocoaPods

Information CocoaPods is being deprecated. MoEngage recommends using Swift Package Manager for all new integrations. For more info, refer here.

1. Add the following line to your Podfile inside your app target.

The react-native-moengage package already brings in MoEngage-iOS-SDK, you only need to add the RichNotification subspec.

pod 'MoEngage-iOS-SDK/RichNotification'

2. Run pod install:

 pod repo update
 pod install

Step 3: Integrate the extension integrator tool

Automate the extension configuration by adding a custom script to your build process.

1. In Xcode, select your application target, go to Build Phases, and click + to add a New Run Script Phase.

If you have already added a script phase and configured the input files, you can simply update the run command as described in step 3 below.

2. Add the following paths to the Input Files section:

• $(BUILT_PRODUCTS_DIR)/$(INFOPLIST_PATH)
• $(INSTALL_DIR)/$(INFOPLIST_PATH)

3. In the shell script input box of the Run Script Phase added in step 1, enter the command relevant to your dependency manager, replacing $OPTIONS with your desired configuration:

Swift Package Manager (SPM)

Swift Package Manager (SPM)

case "$ACTION" in
  install) SPM_ROOT="$OBJROOT/../../../../.." ;;   # xcodebuild archive
  *)       SPM_ROOT="$OBJROOT/../.." ;;            # build / run from Xcode
esac
"$SPM_ROOT/SourcePackages/artifacts/apple-sdk/moengage-extensions-integration/moengage-extensions-integration.artifactbundle/moengage-extensions-integration/bin/moengage-extensions-integration" $OPTIONS

CocoaPods

CocoaPods

  ${PODS_ROOT}/MoEngageExtensionsIntegration/moengage-extensions-integration.artifactbundle/moengage-extensions-integration/bin/moengage-extensions-integration $OPTIONS

Available options

Replace $OPTIONS with one or more of the following:

Option	Description
--enable-push-notification-templates	Required if the content extension from Step 2 is used.
--notification-service-extension-name $CUSTOM_SERVICE_EXTENSION_NAME	Sets a custom name for the service extension. Use this when migrating to this tool from a custom service extension implementation. (Default: MoEngageNotificationService).
--notification-content-extension-name $CUSTOM_CONTENT_EXTENSION_NAME	Sets a custom name for the content extension. Use this when migrating to this tool from a custom content extension implementation. (Default: MoEngageNotificationContent).

Step 3: Remove existing extensions

Remove existing service and content extensions added in Frameworks, Libraries and Embedded Content section.

Failing to remove prevents push delivery impressions and rich push notifications.