Migration guide

Minimal supported iOS version has been changed to iOS 12.

API Deprecations

Simplified 3D Secure 2.x integration

Since Mobile SDK 5.0.0 the external initialization of 3DS service was removed. Now it is fully managed by Mobile SDK. Please check 3D Secure 2 page for more details. Check your integration for OPPThreeDSService leftovers and remove if any.

Use the threeDSConfig property of the OPPCheckoutSettings instance to assign OPPThreeDSConfig.

OPPThreeDSConfig *config = [[OPPThreeDSConfig alloc] init];
checkoutSettings.threeDSConfig = config;

let config = OPPThreeDSConfig()
checkoutSettings.threeDSConfig = config

Core API Deprecations

One framework instead of two

Mobile 3DS SDK wrapper OPPWAMobile_ThreeDS.xcframework is deprecated now - all 3DS functionality is build into Mobile SDK OPPWAMobile.xcframework. So before moving forward:

1. Remove OPPWAMobile_ThreeDS.xcframework from your project.


2. Review your project settings - General and Build Phases tabs for ThreeDS wrapper leftovers.

Import mandatory library

As 3DS SDK now is a part of Mobile SDK you have to import the following framework to the project:

ipworks3ds_sdk.xcframework // certified 3DS SDK

There are two versions of the ipworks3ds_sdk.xcframework included: one to be used for development and one for production. The production version includes more strict security measures that would not allow for common development processes to occur, including running with attached debuggers or using simulators/emulators. The deployment version includes _deploy in the filename.

1. Drap and drop ipworks3ds_sdk.xcframework to the "Frameworks" folder of your project.
   Make sure "Copy items if needed" is checked.


2. Embed the frameworks
   • Go to the app target’s General configuration page.
   • Add the frameworks target to the Frameworks, Libraries, and Embedded Content section by clicking the Add icon.


3. Review your Build Phases:
   • ipworks3ds_sdk.xcframework is added to the "Link Binary With Libraries".

New format of framework

Mobile SDK is migrated from Universal (FAT) Framework to Apple's new framework format XCFrameworks, which means the following changes for you:

1. Remove OPPWAMobile.framework & OPPWAMobile-Resources.bundle from your project.


2. Drag and drop OPPWAMobile.xcframework to the "Frameworks" folder of your project.
Make sure "Copy items if needed" is checked.


3. Check "Frameworks, Libraries, and Embedded Content" section under the general settings tab of your application's target. Ensure the Embed dropdown has Embed and Sign selected for the framework.

Customization of localized strings

The way you can customize localized strings in Ready-to-use UI is slightly changed. So if you're using this feature, you have to adapt your project for the new version of mSDK.

Previously you could change and add customized strings right in the OPPWAMobile-Resources.bundle.
Now you should do the same changes but on the level of your application.

In short, you should create OPPCheckout.string file in your project and localize it. Here you will be able to override and add any label of Ready-to-use UI for any language.

String keys remains the same, you just need to move customized strings from the mSDK bundle to your app. See the full guide for details.

1. Drag and drop needed libraries to the "Frameworks" folder of your project.
   • OPPWAMobile-CardIO.framework
   • OPPWAMobile-Alipay.framework


2. Make sure the frameworks are added to the Embedded Binaries as well.


3. Add a Run Script

The framework contains a build for both the simulator (i386, x86_64) and the actual devices (ARM). As it is not permitted to submit a binary for an unsupported architecture to App Store, you have to add script that "manually" removes unused architectures from the final binary.

• Go to the app target’s Build Phases tab.
• In Xcode menu, select Editor > Add Build Phase > Add Run Script Build Phase. You should now see a Run Script section in your Build Phase options.
  Important: "Run Script" phase should be put after "Embed Framework" phase. You can reoder build phases by dragging them using your mouse.
• Set it to use /bin/sh and check the Run script only when installing option.
• Enter the following script:

APP_PATH="${TARGET_BUILD_DIR}/${WRAPPER_NAME}"
find "$APP_PATH" -name 'OPPWAMobile*.framework' -type d | while read -r FRAMEWORK
do
    FRAMEWORK_EXECUTABLE_NAME=$(defaults read "$FRAMEWORK/Info.plist" CFBundleExecutable)
    FRAMEWORK_EXECUTABLE_PATH="$FRAMEWORK/$FRAMEWORK_EXECUTABLE_NAME"
    echo "Executable is $FRAMEWORK_EXECUTABLE_PATH"

    EXTRACTED_ARCHS=()

    for ARCH in $ARCHS
    do
        echo "Extracting $ARCH from $FRAMEWORK_EXECUTABLE_NAME"
        lipo -extract "$ARCH" "$FRAMEWORK_EXECUTABLE_PATH" -o "$FRAMEWORK_EXECUTABLE_PATH-$ARCH"
        EXTRACTED_ARCHS+=("$FRAMEWORK_EXECUTABLE_PATH-$ARCH")
    done

    echo "Merging extracted architectures: ${ARCHS}"
    lipo -o "$FRAMEWORK_EXECUTABLE_PATH-merged" -create "${EXTRACTED_ARCHS[@]}"
    rm "${EXTRACTED_ARCHS[@]}"

    echo "Replacing original executable with thinned version"
    rm "$FRAMEWORK_EXECUTABLE_PATH"
    mv "$FRAMEWORK_EXECUTABLE_PATH-merged" "$FRAMEWORK_EXECUTABLE_PATH"

done

• Accelerate
• AudioToolbox
• AVFoundation
• CoreMedia
• MobileCoreServices
• CoreTelephony
• CoreMotion
• libz.tbd
• libc++.tbd