iOS
[Xcode 27] SceneDelegate Migration Required — Additional Setup Needed for Airbridge Deep Links
[Xcode 27] SceneDelegate Migration Required — Additional Setup Needed for Airbridge Deep Links
AttentionThis troubleshooting guide is for customers who need to migrate an existing AppDelegate-based app to UIScene(SceneDelegate) lifecycle.
Symptoms
- When an app built with Xcode 27 is launched, the app may not run properly.
- Airbridge deep link events are not collected even when the app is opened through a scheme deep link or Universal Link.
- The app does not work even though the code was added to
AppDelegateas shown in the Initialize SDK and Collect deep link events in your app developer guide examples.
Cause
Apple is moving the app lifecycle from theUIApplicationDelegate-only AppDelegate model to the UIScene-based SceneDelegate model, and adopting the Scene lifecycle has effectively become required in the latest Xcode and iOS environments.When an app adopts the Scene lifecycle through UIApplicationSceneManifest, the following AppDelegate deep link callbacks are no longer called.Solution
Airbridge Unreal SDK versions earlier than 4.10.0 do not provide a public interface for calling Airbridge deep links. Update Airbridge Unreal SDK to 4.10.0 or later, and then call Airbridge deep links from SceneDelegate.1. Add Scene Manifest to Info.plist
Add the following Scene configuration to Info.plist in the Xcode project through UPL.2. Create SceneDelegate and add deep link collection code
Create a SceneDelegate file that matches theUISceneDelegateClassName added to Scene Manifest.3. Add deep link collection code
Implement the following code in the created SceneDelegate to collect Airbridge deep links.The domain of saved passwords appears as airbridge.io or abr.ge
The domain of saved passwords appears as airbridge.io or abr.ge
Problem
Users may see the domain of passwords stored with the Password AutoFill feature as airbridge.io or abr.ge.Cause
After setting up deep links for the Airbridge SDK, if you utilize the Password AutoFill feature, the domain is saved as the applinks domain of the Airbridge deep link, which is airbridge.io or abr.ge.Solution
The problem can be solved by setting up the webcredentials domain used in the Password AutoFill.- Prepare the domain that will store the password.
-
Host the JSON below at
https://YOUR_DOMAIN/.well-known/apple-app-site-associationwithContent-Type: application/json. Your prepared domain should be entered instead ofYOUR_DOMAIN.
- Navigate to [YOUR_PROJECT]>[Signing & Capabilities] in Xcode.
-
Click + Capability to add Associated Domains. Enter
webcredentials:YOUR_DOMAINin Associated Domains.
Upload Symbol Failed on Xcode
Upload Symbol Failed on Xcode
Android
A coroutine dependency error occurs during the build process
A coroutine dependency error occurs during the build process
Issue
A coroutine dependency error occurs during the build process with the following message.Text
Cause
If the kotlinx-coroutines-core library version is 1.3.5 or later, the kotlin-stdlib library version must be at a certain level or later.Solution
Check whether the kotlin-stdlib library version is v.1.3.70 or later with thegradlew dependencies command. If the version is earlier than v.1.3.70, you need to update it.Deeplink Opens generated through push notifications using the Braze SDK are not collected
Deeplink Opens generated through push notifications using the Braze SDK are not collected
Issue
Deeplink Open events that occur through the push notifications generated by the Braze SDK are not collected by Airbridge. Instead, the App Open event is collected.Cause
The Airbridge Android SDK uses thedataString in the action and intent of the Activity to distinguish between Deeplink Open events and App Open events.When a user opens the app through a push notification using the Braze SDK, the app goes through NotificationTrampolineActivity. This activity handles push notifications, but the dataString is not included in its action and intent, preventing the SDK from determining if it’s a Deeplink Open event or an App Open event.Solution
Add a custom Application class (CustomApplication.java) file as shown below.The "Manifest merger failed" error occurrs during the build process
The "Manifest merger failed" error occurrs during the build process
Issue
The “Manifest merger failed” error occurrs during the build process.Cause
The Airbridge SDK’sAndroidManifest.xml includes rules to opt-out of backing up the Shared Preferences data. The purpose of this rule is to avoid retaining the same Airbridge settings during the reinstallation of the app so that new installs or reinstalls can be detected accurately.Merging Airbridge SDK backup rules with your app backup rules can cause conflicts.Solution
Below are the opt-out rules defined in the Airbridge SDK.Fix conflict with fullBackupContent=“string”
Addingandroid:fullBackupContent="string" to the AndroidManifest.xml may cause an error like the following.Build Output
- add
xmlns:tools="http://schemas.android.com/tools"in thePlatforms > Android > Extra Tags for <manifest> nodeto the Unreal Editor Project Settings window. - add
tools:replace="android:fullBackupContent"in thePlatforms > Android > Extra Tags for <application> nodeto the Unreal Editor Project Settings window.
Fix conflict with dataExtractionRules=“string resource”
Addingandroid:dataExtractionRules="string resource" to the AndroidManifest.xml may cause an error like the following.Build Output
- add
xmlns:tools="http://schemas.android.com/tools"to thePlatforms > Android > Extra Tags for <manifest> nodein the Unreal Editor Project Settings window. - add
tools:replace="android:dataExtractionRules"to thePlatforms > Android > Extra Tags for <application> nodein the Unreal Editor Project Settings window.
Fix conflict with allowBackup=“false”
If you addandroid:allowBackup="false" in the AndroidManifest.xml, you might get the following error:Build Output
- add
xmlns:tools="http://schemas.android.com/tools"to thePlatforms > Android > Extra Tags for <manifest> nodein the Unreal Editor Project Settings window. - add
tools:replace="android:allowBackup"to thePlatforms > Android > Extra Tags for <application> nodein the Unreal Editor Project Settings window.
If compileSdkVersion is l than 31
Theandroid:dataExtractionRules has been added in API Level 31. Therefore, if the compileSdkVersion is lower than 31, an error like the following may occur.Build Output
- add
xmlns:tools="http://schemas.android.com/tools"to thePlatforms > Android > Extra Tags for <manifest> nodein the Unreal Editor Project Settings window. - add
tools:remove="android:dataExtractionRules"to thePlatforms > Android > Extra Tags for <application> nodein the Unreal Editor Project Settings window.
Resolve Airbridge SDK backup rules merge conflict issue
Resolve Airbridge SDK backup rules merge conflict issue
Issue
If an Airbridge SDK backup rule and a backup rule for a different third-party SDK (e.g., AppsFlyer SDK) overlap, you will see the build error below.Cause
Overlapping of the Airbridge SDK backup rules and third-party SDK backup rules can cause build errors.Solution
backup_rules.xml setup
-
Create a file (e.g.,
custom_backup_rules.xml) within the module directory. -
Add the data backup rules defined by the Airbridge SDK as follows.
-
Using the Unreal Plugin Language (UPL), copy the file into your
res/xmlfolder as follows.
data_extraction_rules.xml setup
-
Create a file (e.g.,
custom_data_extraction_rules.xml) within the module directory. -
Add the data backup rules defined by the Airbridge SDK as follows.
-
Using the Unreal Plugin Language (UPL), copy the file into your
res/xmlfolder as follows.
AndroidManifest.xml setup
In the Unreal Editor Project Settings window, add the following element to the Platforms - Android > Advanced APK Packaging > Extra Tags for <manifest> node.xmlns:tools="http://schemas.android.com/tools"
Platforms - Android > Advanced APK Packaging > Extra Tags for <application> node.android:allowBackup="true"android:fullBackupContent="@xml/custom_backup_rules"android:dataExtractionRules="@xml/custom_data_extraction_rules"tools:replace="android:fullBackupContent, android:dataExtractionRules"
GAID is collected as 00000000-0000-0000-0000-000000000000
GAID is collected as 00000000-0000-0000-0000-000000000000