Configure the Content Extension for the iOS Extension SDK

Set up and configure the Notification Content Extension for use with the iOS Extension for the Salesforce Engagement SDK.

The notification content extension is a bundle within your main app. To add a content extension target, complete these steps.

1. In Xcode, go to File > New > Target.

2. In the iOS > Application Extension section, select Notification Content Extension.

3. Click Next.

4. Configure the app extension and click Finish.

5. In the General Settings section for your project target, verify that the new extension is listed under Frameworks, Libraries, and Embedded Content. If it isn’t listed there, add it.

   Use the same Xcode-managed profile for the extension targets as the main project. Match the content extension version to the main app version whenever possible, and prefix the content extension bundle ID with the main app’s bundle ID. For example, if the main app’s bundle ID is com.salesforce.MyAwesomeApp, the content extension bundle ID can be com.salesforce.MyAwesomeApp.MyContentExtension.

To integrate the iOS Extension with the Content Extension, add the dependencies to CocoaPods or Swift Package Manager (SPM). You can also add the dependencies manually.

• Integrate the SDK with CocoaPods
• Integrate the SDK with Swift Package Manager (SPM)
• Integrate the SDK Manually

If you use CocoaPods to manage dependencies for your app, add the extension SDK to your Podfile.

1. Update your Podfile to include the extension SDK.

2. In your project directory, run pod install.
3. Open the .xcworkspace file that CocoaPods generates.

For more information about updating Podfiles, see Using CocoaPods: Adding pods to an Xcode project on the CocoaPods documentation site.

If you use Swift Package Manager (SPM) to manage dependencies for your app, add the extension SDK to your project.

1. On the Package Dependencies tab of your project’s settings, click the plus sign (+) to add a package.
2. Search for the package MCExtensionSDK using the URL https://github.com/salesforce-marketingcloud/extension-sdk-ios.git
3. Select the package to include it in your app.

If you don’t use CocoaPods or Swift Package Manager, add the extension packages manually.

1. Download the MCExtensionSDK.

2. Copy the MCExtensionSDK directory from your downloads folder to your project directory.

   To keep the binary in a different location, adjust the Framework Search Path (FRAMEWORK_SEARCH_PATHS) in your build settings.

3. In your project, select the Content Extension target.

4. In the General Settings for your project, in the Frameworks, Libraries, and Embedded Content section, add the MCExtensionSDK framework.

After you add the dependencies to your project, inherit the main class of the Content Extension from the SFMCNotificationViewController class.

If your project is written in Swift, use this code to inherit the service.

If your project uses ObjectiveC, use this header.

In your ObjectiveC implementation file, use this code.

Configure your content extension’s Info.plist file to register the correct notification category, build the rich push notification UI in code using the Extension SDK, and enable user interaction. These steps make sure that the content extension is correctly triggered and displays the intended rich UI as defined in Marketing Cloud Engagement.

To set up and synchronize the notification category between your content extension’s Info.plist file and the Marketing Cloud Engagement UI:

1. Contact your Marketing Cloud Engagement admin to obtain the correct category name for the Rich UI template.
2. In your content extension’s Info.plist file, replace the value for UNNotificationExtensionCategory under NSExtension > NSExtensionAttributes.

Unlike Apple’s auto-generated content extension template, MCExtensionSDK builds the notification UI programmatically instead of using an Interface Builder file. To modify the project to build the rich push notification UI entirely in code using the MCExtensionSDK:

1. Remove the storyboard reference by deleting the NSExtensionMainStoryboard item from Info.plist > NSExtension.

2. Add the NSExtensionPrincipalClass key to Info.plist > NSExtension

   • Value type: String
   • Value: $(PRODUCT_MODULE_NAME).<MainClassName>

   For Objective-C projects, specify the class name directly.

3. Remove MainInterface.storyboard from your project.

Add this key to your content extension’s Info.plist file:

• Key: UNNotificationExtensionUserInteractionEnabled
• Value type: Boolean
• Value: YES

The MCExtensionSDK manages the content extension lifecycle. You can customize some of the ways the extension behaves:

• Enabling or disabling logging and configuring log levels
• Adjusting the HTTP request timeout

If your project is written in Swift, implement the sfmcProvideConfig() method to define custom log levels and HTTP timeout settings for the extension.

If your project uses ObjectiveC, use the sfmcProvideConfig method to configure logging behavior and HTTP request timeout values for the extension.