{"componentChunkName":"component---src-templates-markdown-template-jsx","path":"/developers/client-sdks/ios/upgrade-to-version-9/","result":{"data":{"pageMetadata":{"title":"Upgrade to Version 9","path":"/developers/client-sdks/ios/upgrade-to-version-9/","sourceCode":null,"metadataParent":{"title":"iOS","path":"/developers/client-sdks/ios/","sourceCode":"https://github.com/mParticle/mparticle-apple-sdk","hasVersionPicker":null,"metadataChildren":[{"title":"Initialization","path":"/developers/client-sdks/ios/initialization/","order":2,"label":null},{"title":"Configuration","path":"/developers/client-sdks/ios/configuration/","order":3,"label":null},{"title":"Event Tracking","path":"/developers/client-sdks/ios/event-tracking/","order":4,"label":null},{"title":"User Attributes","path":"/developers/client-sdks/ios/users/","order":5,"label":null},{"title":"IDSync","path":"/developers/client-sdks/ios/idsync/","order":6,"label":null},{"title":"Screen Tracking","path":"/developers/client-sdks/ios/screen-tracking/","order":7,"label":null},{"title":"Commerce Events","path":"/developers/client-sdks/ios/commerce-tracking/","order":8,"label":null},{"title":"Location Tracking","path":"/developers/client-sdks/ios/location/","order":9,"label":null},{"title":"Media","path":"/developers/client-sdks/ios/media/","order":10,"label":null},{"title":"Kits","path":"/developers/client-sdks/ios/kits/","order":11,"label":null},{"title":"Application State and Session Management","path":"/developers/client-sdks/ios/session-management/","order":12,"label":null},{"title":"Data Privacy Controls","path":"/developers/client-sdks/ios/data-privacy-controls/","order":13,"label":null},{"title":"Error Tracking","path":"/developers/client-sdks/ios/error-and-exception-tracking/","order":14,"label":null},{"title":"Opt Out","path":"/developers/client-sdks/ios/opt-out/","order":14,"label":null},{"title":"Push Notifications","path":"/developers/client-sdks/ios/push-notifications/","order":15,"label":null},{"title":"Webview Integration","path":"/developers/client-sdks/ios/webview-integration/","order":16,"label":null},{"title":"Upload Frequency","path":"/developers/client-sdks/ios/upload-frequency/","order":17,"label":null},{"title":"Preventing Blocked HTTP Traffic with CNAME","path":"/developers/client-sdks/ios/prevent-blocked-http-traffic/","order":19,"label":null},{"title":"Linting Data Plans","path":"/developers/client-sdks/ios/linting/","order":20,"label":null},{"title":"Troubleshooting iOS SDK","path":"/developers/client-sdks/ios/troubleshooting/","order":21,"label":null},{"title":"Social Networks","path":"/developers/client-sdks/ios/social-networks/","order":22,"label":null},{"title":"iOS 14 Guide","path":"/developers/client-sdks/ios/ios14/","order":23,"label":null},{"title":"iOS 15 FAQ","path":"/developers/client-sdks/ios/ios15/","order":24,"label":null},{"title":"iOS 16 FAQ","path":"/developers/client-sdks/ios/ios16/","order":25,"label":null},{"title":"iOS 17 FAQ","path":"/developers/client-sdks/ios/ios17/","order":26,"label":null},{"title":"iOS 18 FAQ","path":"/developers/client-sdks/ios/ios18/","order":27,"label":null},{"title":"API Reference","path":"/developers/client-sdks/ios/api-reference/","order":28,"label":null},{"title":"Upgrade to Version 7","path":"/developers/client-sdks/ios/upgrade-to-version-7/","order":29,"label":null},{"title":"Upgrade to Version 9","path":"/developers/client-sdks/ios/upgrade-to-version-9/","order":30,"label":null},{"title":null,"path":"/developers/client-sdks/ios/changelog/","order":null,"label":null},{"title":"Workspace Switching","path":"/developers/client-sdks/ios/workspace-switching-and-multi-instance-support/","order":null,"label":null}],"metadataParent":{"title":"Client SDKs","path":"/developers/client-sdks/","metadataChildren":[{"title":"Alexa","path":"/developers/client-sdks/alexa/","order":1,"label":null},{"title":"AMP","path":"/developers/client-sdks/amp/","order":null,"label":null},{"title":"Android","path":"/developers/client-sdks/android/","order":null,"label":null},{"title":"Cordova","path":"/developers/client-sdks/cordova/","order":null,"label":null},{"title":"Direct Url Routing","path":"/developers/client-sdks/direct-url-routing/","order":null,"label":null},{"title":"Flutter","path":"/developers/client-sdks/flutter/","order":null,"label":null},{"title":"iOS","path":"/developers/client-sdks/ios/","order":null,"label":null},{"title":"React Native","path":"/developers/client-sdks/react-native/","order":null,"label":null},{"title":"Roku","path":"/developers/client-sdks/roku/","order":null,"label":null},{"title":"Unity","path":"/developers/client-sdks/unity/","order":null,"label":null},{"title":"Web","path":"/developers/client-sdks/web/","order":null,"label":null},{"title":"Xamarin","path":"/developers/client-sdks/xamarin/","order":null,"label":null},{"title":"Xbox","path":"/developers/client-sdks/uwp/","order":null,"label":null}],"metadataParent":{"title":"Developers","path":"/developers/","metadataChildren":[{"title":"API Credential Management","path":"/developers/credential-management/","order":null,"label":null},{"title":"API References","path":"/developers/apis/","order":null,"label":null},{"title":"Client SDKs","path":"/developers/client-sdks/","order":null,"label":null},{"title":"Guides","path":"/developers/guides/","order":null,"label":null},{"title":"Media SDKs","path":"/developers/media-sdks/","order":null,"label":null},{"title":"Quickstart","path":"/developers/quickstart/","order":null,"label":null},{"title":"Server SDKs","path":"/developers/server-sdks/","order":null,"label":null},{"title":"The Developer's Guided Journey to mParticle","path":"/developers/developersjourney/","order":null,"label":null},{"title":"Tools","path":"/developers/tools/","order":null,"label":null}],"metadataParent":null}}}},"markdownRemark":{"html":"

Version 9 of the Apple SDK contains breaking changes from version 8.x, including removal of the AppDelegateProxy (you must now forward push, URL, and user-activity events to the SDK), removal of deprecated UIApplicationDelegate URL/activity methods in favor of the UIScene lifecycle, removal of location support and the NoLocation variant, removal of support for iOS app extension targets, removal of Carthage distribution (use Swift Package Manager or CocoaPods instead), direct routing to regional endpoints by default, and API changes for MPRokt and listener callbacks. The SDK’s minimum deployment is iOS 15 and tvOS 15. This guide covers migration from versions < 9.0.0. For migration from SDK 7.x to 8.x, see the mParticle Apple SDK migration guide v8 on GitHub.

\n

\n \n \n \n \n \n \n \n Imports (Swift, Objective-C, and Rokt)

\n

Swift: Use import mParticle_Apple_SDK for all public SDK APIs, including Rokt types (such as RoktEvent) that the kit re-exports. You do not need a separate import RoktContracts in Swift for typical mParticle + Rokt usage.

\n

Objective-C: Prefer #import <mParticle_Apple_SDK.h>, or @import mParticle_Apple_SDK; when modules are enabled. If a source file references Rokt SDK types directly (for example in blocks that take RoktEvent *), add @import RoktContracts; (or the equivalent for your build) in that file only.

\n

Swift Package Manager: Depend on the single product mParticle-Apple-SDK; the old mParticle-Apple-SDK-NoLocation product name is no longer used (see Removed Location Support).

\n

\n \n \n \n \n \n \n \n Removed AppDelegateProxy

\n

The AppDelegateProxy feature has been removed from the SDK. The SDK no longer automatically intercepts UIApplicationDelegate messages for push notifications, URL opening, or user activity. You must explicitly forward these events to the SDK from your app delegate or scene delegate.

\n

\n \n \n \n \n \n \n \n What Has Changed

\n\n

\n \n \n \n \n \n \n \n Migration Steps

\n

If you were using proxyAppDelegate = YES (the default), you must now forward app delegate events to the SDK. See Push Notifications and Configuration – Forwarding app lifecycle events for the required code.

\n\n
\n

\n \n \n \n \n \n \n \n Removed Legacy Database Migration Support

\n

Support for migrating from SDK versions prior to 8.27.0 (internal database version < 30) has been removed. Only migration from the immediately preceding database version (v30 → v31) is supported.

\n

\n \n \n \n \n \n \n \n What This Means

\n\n

This only affects apps that are upgrading directly from mParticle SDK versions before 8.27.0 (released August 2024) and that have pending events not yet uploaded to mParticle.

\n
\n

\n \n \n \n \n \n \n \n Removed MPListenerController

\n

The MPListenerController class has been removed. The SDK no longer invokes any listener callbacks.

\n
\n

\n \n \n \n \n \n \n \n App extension targets

\n

The mParticle Apple SDK 9.x does not support iOS app extension targets. If you need the SDK in an extension, you can continue using 8.x. If you require continued app extension support beyond that path, contact your mParticle representative.

\n
\n

\n \n \n \n \n \n \n \n Removed Carthage support

\n

Carthage is no longer supported for the mParticle Apple SDK as of 9.0.0. Integrate the SDK with Swift Package Manager or CocoaPods, or build manually from source. If you relied on Carthage with SDK 8.x, migrate your dependency to SPM or CocoaPods before upgrading.

\n
\n

\n \n \n \n \n \n \n \n Direct Routing Enabled by Default

\n

API requests now route directly to regional endpoints based on your API key prefix.

\n

Before (8.x):

\n\n

After (9.x):

\n\n

Examples by API key format:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
API Key FormatEvents EndpointEvents Tracking EndpointIdentity EndpointIdentity Tracking Endpoint
xxxxx (legacy, no prefix)nativesdks.us1.mparticle.comtracking-nativesdks.us1.mparticle.comidentity.us1.mparticle.comtracking-identity.us1.mparticle.com
us1-xxxxxnativesdks.us1.mparticle.comtracking-nativesdks.us1.mparticle.comidentity.us1.mparticle.comtracking-identity.us1.mparticle.com
us2-xxxxxnativesdks.us2.mparticle.comtracking-nativesdks.us2.mparticle.comidentity.us2.mparticle.comtracking-identity.us2.mparticle.com
eu1-xxxxxnativesdks.eu1.mparticle.comtracking-nativesdks.eu1.mparticle.comidentity.eu1.mparticle.comtracking-identity.eu1.mparticle.com
au1-xxxxxnativesdks.au1.mparticle.comtracking-nativesdks.au1.mparticle.comidentity.au1.mparticle.comtracking-identity.au1.mparticle.com
\n

If your app has strict App Transport Security (ATS) settings, you may need to add NSIncludesSubdomains set to YES for the mparticle.com domain in your Info.plist to allow connections to regional subdomains.

\n
\n

\n \n \n \n \n \n \n \n Removed Deprecated UIApplicationDelegate Methods

\n

Apple has deprecated several UIApplicationDelegate protocol methods in favor of the UIScene lifecycle. The mParticle SDK has removed its wrapper methods for these deprecated delegate methods. Use the UIScene-based APIs in your SceneDelegate instead. The SDK’s minimum deployment is iOS 15 and tvOS 15, so the UIScene lifecycle is always available.

\n

\n \n \n \n \n \n \n \n What Has Changed

\n

The following methods have been removed from the MParticle class:

\n\n

\n \n \n \n \n \n \n \n Migration Steps

\n

Use the UIScene lifecycle in your SceneDelegate and call the new SDK methods.

\n

URL handling — use handleURLContext: in your SceneDelegate:

\n
\n
// In SceneDelegate\n- (void)scene:(UIScene *)scene openURLContexts:(NSSet<UIOpenURLContext *> *)URLContexts {\n    for (UIOpenURLContext *urlContext in URLContexts) {\n        [[MParticle sharedInstance] handleURLContext:urlContext];\n    }\n}
\n
// In SceneDelegate\nfunc scene(_ scene: UIScene, openURLContexts URLContexts: Set<UIOpenURLContext>) {\n    for urlContext in URLContexts {\n        MParticle.sharedInstance().handleURLContext(urlContext)\n    }\n}
\n
\n

User activity (universal links, Handoff) — use handleUserActivity: in your SceneDelegate:

\n
\n
// In SceneDelegate\n- (void)scene:(UIScene *)scene continueUserActivity:(NSUserActivity *)userActivity {\n    [[MParticle sharedInstance] handleUserActivity:userActivity];\n}
\n
// In SceneDelegate\nfunc scene(_ scene: UIScene, continue userActivity: NSUserActivity) {\n    MParticle.sharedInstance().handleUserActivity(userActivity)\n}
\n
\n\n
\n

\n \n \n \n \n \n \n \n Removed Location Support

\n

In version 9.0.0, location support has been removed from the SDK. The SDK now provides a single target without location functionality.

\n

\n \n \n \n \n \n \n \n What Has Changed

\n\n

\n \n \n \n \n \n \n \n Migration Steps

\n

If you were using a target with Location support:
\nSwitch your project to the standard target (no Location suffix) and remove any location-related dependencies, imports, or build scripts.

\n

If you were using the NoLocation variant (e.g. mParticle-Apple-SDK-NoLocation):

\n
    \n
  1. Replace the NoLocation import/product with the standard name: mParticle-Apple-SDK
    2. \n
  2. Update Package.swift or Podfile to use the standard target/product name
    3. \n
\n

Swift Package Manager example:

\n
\n
// Before (NoLocation variant)\n.target(\n    name: \"MyTarget\",\n    dependencies: [\n        .product(name: \"mParticle-Apple-SDK-NoLocation\", package: \"mParticle-Apple-SDK\")\n    ]\n)\n\n// After (standard target)\n.target(\n    name: \"MyTarget\",\n    dependencies: [\n        .product(name: \"mParticle-Apple-SDK\", package: \"mParticle-Apple-SDK\")\n    ]\n)
\n
\n
\n

\n \n \n \n \n \n \n \n MPRokt API Changes

\n

The MPRokt interface has been updated to align with the Rokt SDK 5.0.x API: multiple callback parameters are replaced with a unified event-based callback, and some parameter names have changed.

\n

\n \n \n \n \n \n \n \n What Has Changed

\n\n

\n \n \n \n \n \n \n \n Event Mapping Reference

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Old CallbackNew Event Class
onLoadMPRoktPlacementReady
onUnLoadMPRoktPlacementClosed
onShouldShowLoadingIndicatorMPRoktShowLoadingIndicator
onShouldHideLoadingIndicatorMPRoktHideLoadingIndicator
onEmbeddedSizeChangeMPRoktEmbeddedSizeChanged
\n

Use the onEvent callback and type-check the event to handle specific cases. Remove any references to MPRoktEventCallback. For full code examples, see the mParticle Apple SDK MIGRATING.md on GitHub.

\n
\n

\n \n \n \n \n \n \n \n Upgrade Checklist

\n","frontmatter":{"title":"Upgrade to Version 9","order":30,"seoTitle":null,"seoDescription":null},"parent":{"__typename":"File","modifiedTime":"April 10, 2026"}}},"pageContext":{"slug":"/developers/client-sdks/ios/upgrade-to-version-9/"}},"staticQueryHashes":["2950460867"]}