Upgrade the SDK from Version 8 to Version 9

Version 9 of the SDK expands your iOS push messaging capabilities with the introduction of carousel push notifications, push delivery events, and Inbox 2.0 support. Upgrading to this version enables you to create more engaging interactive push notifications, gain valuable delivery insights, and enhance your in-app messaging with richer content and flexible call-to-action options.

The upgrade steps include integrating the new iOS Extension SDK, updating PushInterface method signatures, and migrating iOS Service Extension code.

Integrate the iOS Extension SDK

Push delivery events and carousel templates require Service and Content Extensions, which are included with the iOS Extension SDK. For installation information, see Integrate the iOS Extension SDK.

Update PushInterface Method Signatures

Version 9 of the SDK for iOS introduces changes to the PushInterface method signatures to support Carousel push notifications and Inbox 2.0 features. These updates involve modifications to the UNUserNotificationCenterDelegate implementation and the removal of custom inbox message handling methods.

Update UNUserNotificationCenterDelegate Implementation

Update your existing UNUserNotificationCenterDelegate implementation as shown in this example.

1// REQUIRED IMPLEMENTATION
2// The method will be called on the delegate when the user responded to the notification by opening the application,
3// dismissing the notification or choosing a UNNotificationAction.
4// The delegate must be set before the application returns from applicationDidFinishLaunching:.
5@available(iOS 10.0, *)
6func userNotificationCenter(_ center: UNUserNotificationCenter, didReceive response: UNNotificationResponse, withCompletionHandler completionHandler: @escaping () -> Void) {
7    // Required: tell the MarketingCloudSDK about the notification. This will collect mobile app analytics
8    // and process the notification on behalf of your application.
9    SFMCSdk.requestPushSdk { mp in
10        mp.setNotificationResponse(response)
11    }
12    completionHandler()
13}

Inbox Message Handling Changes

In version 9.0.0 and later, the SDK for iOS doesn’t support custom data sources and delegates for the inbox table view. These methods have been removed:

1public func inboxMessagesTableViewDataSourceFor(tableView: UITableView) -> InboxMessagesDataSource?
2public func inboxMessagesTableViewDelegateFor(tableView: UITableView, dataSource: InboxMessagesDataSource) -> InboxMessagesDelegate?

To manage inbox messages, use the built-in SDK methods instead of custom data sources and delegates.

Note

Migrate Service Extension Code

The iOS Extension SDK now provides built-in methods for handling common Service Extension tasks, such as customizing notification content and managing push notification delivery. If your app uses custom code in its Service Extension, use the provided customization methods of the iOS Extension SDK.

For a complete implementation example, see the iOS LearningApp.