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.handleURLFromNotification(response.notification)
    }

Handling URL links in app

RadarURLDelegate

RadarURLDelegate is a light weight way to handle the URL navigation in app.

To handle the deep link URL, one can implement RadarURLDelegate to handle the URL that is passed down by the on premise notification.

class AppDelegate: UIResponder, UIApplicationDelegate, RadarURLDelegate ... {
    
    func didHandleURL(_ url: URL) -> Bool {
        print(" called with url %@", url)
        // handle navigation here
        //return if the URL was successfully handled
        return true
    }

It is optional to implement RadarURLDelegate and to set the radarInitializeOptions.urlDelegate to YES.

Default iOS setup

If the radarInitializeOptions.urlDelegate is not defined or returns false, we will default to calling [application openURL:url options:@{} completionHandler:nil];

If you're not relying on the RadarURLDelegate, 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)

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

[lmeier]

Have we tested this in Waypoint yet?

[lmeier]

linting

[lmeier]

this is deprecated: https://developer.apple.com/documentation/uikit/uiapplication/1622961-openurl

looks like this is how we'd want to do this: https://developer.apple.com/documentation/uikit/uiapplication/1648685-open

[KennyHuRadar]

I think I'm using the right objective C version of it: https://developer.apple.com/documentation/uikit/uiapplication/1648685-openurl?language=objc

[lmeier]

change to openURLFromNotification