iOS deep linking

[KennyHuRadar]

This PR adds deep linking support to the SDK.

Dashboard Setup

From the dashboard, an user should configure the geofence metadata to include the key value pair for radar:notificationURL

SDK setup

Automatic Setup

The user can also perform the following to have setup done automatically

radarInitializeOptions.autoHandleNotificationDeepLinks = true
Radar.initialize(publishableKey: "prj_test_pk_000", options: radarInitializeOptions )

Manual Setup

If the user does not wish to use the automatic setup, the user should implement

    func userNotificationCenter(_ center: UNUserNotificationCenter, didReceive response: UNNotificationResponse) async {
        Radar.openURLFromNotification(response.notification)
    }

Handling URL links in app

Default iOS setup

Under the hood, we will default to calling [application openURL:url options:@{} completionHandler:nil];

You should implement

func application(_ app: UIApplication, open url: URL,
                     options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool

or

func scene(_ scene: UIScene, 
           willConnectTo session: UISceneSession, 
           options connectionOptions: UIScene.ConnectionOptions)

Developers should perform the standard iOS setup for deep linking/ universal linking.

React native setup

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
  self.moduleName = @"main";

  // You can add your custom initial props in the dictionary below.
  // They will be passed down to the ViewController used by React Native.
  self.initialProps = @{};

  BOOL res = [super application:application didFinishLaunchingWithOptions:launchOptions];
  RadarInitializeOptions *radarInitializeOptions = [[RadarInitializeOptions alloc] init];
  radarInitializeOptions.autoHandleNotificationDeepLinks = YES;
  [Radar nativeSetup:radarInitializeOptions];
  return res;
}

Dogfood/ QA:

Using a custom build of waypoint using this dependency: https://expo.dev/accounts/radarlabs/projects/waypoint/builds/37c534bf-d646-4fbb-b412-17b3cd426cca
We create a on premise notification that deeplinks to the setting page.
This feature is currently only available in the staging env

trimmed.deep.link.screen.capture.mov

Other notable changes:

We are extending the nativeSetup call to take in an RadarInitializeOptions object. This is a breaking change, we need to ensure our existing customers are not impacted by this change. We are also extending RadarInitializeOptions to take in another flag, autoHandleNotificationDeepLinks. There are some changes to the swizzling logic as we use it to enable more features. We perform swizzling if any of the flags for automatic setup is true. We swizzle to a method that checks our RadarInitializeOptions object stored in RadarSettings to figure out what actions (handle deep links, log conversions etc) it needs to take at runtime.

[lmeier]

Have we tested this in Waypoint yet?

[KennyHuRadar]

Per discussion at the geofence meeting, we are not going to ship RadarURLDelegate, developers should follow the standard deep linking setup for native and iOS to setup this feature.

[nickpatrick]

@KennyHuRadar Some typos in this comment. e.g., initlizing --> initializing, optiosn --> options, mixing X-platform and crossplatform

I realize comments and release notes don't have any functional impact on the SDK, but I think it's important that we nail the details there, otherwise we look sloppy. cc @lmeier

[nickpatrick]

Intentional?

[nickpatrick]

Nit: Extra space in (void) nativeSetup