Added API initSessionWithSceneOptions

-> Added new API BranchScene:initSessionWithSceneOptions -> Deprecated BranchScene: initSessionWithLaunchOptions -> Added wrapper init APIs in Branch class for including scene identifier.
BranchMetrics · Oct 22, 2024 · 40357e9 · 40357e9
1 parent 146bf4e
commit 40357e9
Show file tree

Hide file tree

Showing 4 changed files with 47 additions and 3 deletions.
diff --git a/Sources/BranchSDK/Branch.m b/Sources/BranchSDK/Branch.m
@@ -616,6 +616,12 @@ - (void)initSessionWithLaunchOptions:(NSDictionary *)options isReferrable:(BOOL)
 
 - (void)initSceneSessionWithLaunchOptions:(NSDictionary *)options isReferrable:(BOOL)isReferrable explicitlyRequestedReferrable:(BOOL)explicitlyRequestedReferrable automaticallyDisplayController:(BOOL)automaticallyDisplayController
                   registerDeepLinkHandler:(void (^)(BNCInitSessionResponse * _Nullable initResponse, NSError * _Nullable error))callback {
+    [self initSceneSessionWithLaunchOptions:options sceneIdentifier:nil isReferrable:isReferrable explicitlyRequestedReferrable:explicitlyRequestedReferrable automaticallyDisplayController:automaticallyDisplayController
+                    registerDeepLinkHandler:callback];
+}
+
+- (void)initSceneSessionWithLaunchOptions:(NSDictionary *)options sceneIdentifier:(NSString *)sceneIdentifier isReferrable:(BOOL)isReferrable explicitlyRequestedReferrable:(BOOL)explicitlyRequestedReferrable automaticallyDisplayController:(BOOL)automaticallyDisplayController
+                  registerDeepLinkHandler:(void (^)(BNCInitSessionResponse * _Nullable initResponse, NSError * _Nullable error))callback {
     NSMutableDictionary * optionsWithDeferredInit = [[NSMutableDictionary alloc ] initWithDictionary:options];
     if (self.deferInitForPluginRuntime) {
         [optionsWithDeferredInit setObject:@1 forKey:@"BRANCH_DEFER_INIT_FOR_PLUGIN_RUNTIME_KEY"];
@@ -624,11 +630,12 @@ - (void)initSceneSessionWithLaunchOptions:(NSDictionary *)options isReferrable:(
     }
     [self deferInitBlock:^{
         self.sceneSessionInitWithCallback = callback;
-        [self initSessionWithLaunchOptions:(NSDictionary *)optionsWithDeferredInit isReferrable:isReferrable explicitlyRequestedReferrable:explicitlyRequestedReferrable automaticallyDisplayController:automaticallyDisplayController];
+        [self initSessionWithLaunchOptions:(NSDictionary *)optionsWithDeferredInit sceneIdentifier:sceneIdentifier isReferrable:isReferrable explicitlyRequestedReferrable:explicitlyRequestedReferrable automaticallyDisplayController:automaticallyDisplayController];
     }];
 }
 
 - (void)initSessionWithLaunchOptions:(NSDictionary *)options
+                     sceneIdentifier:(NSString *)sceneIdentifier
                         isReferrable:(BOOL)isReferrable
        explicitlyRequestedReferrable:(BOOL)explicitlyRequestedReferrable
       automaticallyDisplayController:(BOOL)automaticallyDisplayController {
@@ -650,7 +657,7 @@ - (void)initSessionWithLaunchOptions:(NSDictionary *)options
     #endif
 
     if(pushURL || [[options objectForKey:@"BRANCH_DEFER_INIT_FOR_PLUGIN_RUNTIME_KEY"] isEqualToNumber:@1] || (![options.allKeys containsObject:UIApplicationLaunchOptionsURLKey] && ![options.allKeys containsObject:UIApplicationLaunchOptionsUserActivityDictionaryKey]) ) {
-        [self initUserSessionAndCallCallback:YES sceneIdentifier:nil urlString:pushURL reset:NO];
+        [self initUserSessionAndCallCallback:YES sceneIdentifier:sceneIdentifier urlString:pushURL reset:NO];
     }
 }
 

diff --git a/Sources/BranchSDK/BranchScene.m b/Sources/BranchSDK/BranchScene.m
@@ -35,6 +35,38 @@ - (void)initSessionWithLaunchOptions:(nullable NSDictionary *)options registerDe
     }];
 }
 
+- (void)initSessionWithSceneOptions:(nullable UISceneConnectionOptions *)connectionOptions scene:(UIScene *)scene
+             registerDeepLinkHandler:(void (^ _Nonnull)(NSDictionary * _Nullable params, NSError * _Nullable error, UIScene * _Nullable scene))callback {
+
+    [[BranchLogger shared] logVerbose:[[NSString alloc] initWithFormat:@"connectionOptions : %@", connectionOptions.debugDescription ] error:nil];
+
+    NSMutableDictionary *launchOptions = [[NSMutableDictionary alloc] init];
+
+    if (connectionOptions.userActivities.count ) {
+        launchOptions[UIApplicationLaunchOptionsUserActivityDictionaryKey] = connectionOptions.userActivities.allObjects ;
+    }
+
+    if (connectionOptions.URLContexts.count ) {
+        launchOptions[UIApplicationLaunchOptionsURLKey] = connectionOptions.URLContexts.allObjects ;
+    }
+
+    [[Branch getInstance] initSceneSessionWithLaunchOptions:launchOptions sceneIdentifier:scene.session.persistentIdentifier isReferrable:YES explicitlyRequestedReferrable:NO automaticallyDisplayController:NO registerDeepLinkHandler:^(BNCInitSessionResponse * _Nullable initResponse, NSError * _Nullable error) {
+        if (callback) {
+            if (initResponse) {
+                callback(initResponse.params, error, [self sceneForIdentifier:initResponse.sceneIdentifier]);
+            } else {
+                callback([NSDictionary new], error, [self sceneForIdentifier:initResponse.sceneIdentifier]);
+            }
+        }
+    }];
+
+    if (connectionOptions.userActivities.count) {
+        [self scene:scene continueUserActivity:connectionOptions.userActivities.allObjects.firstObject];
+    } else if (connectionOptions.URLContexts.count) {
+        [self scene:scene openURLContexts:connectionOptions.URLContexts];
+    }
+}
+
 - (void)scene:(UIScene *)scene continueUserActivity:(NSUserActivity *)userActivity NS_EXTENSION_UNAVAILABLE("BranchScene does not support Extensions") {
     [[BranchLogger shared] logVerbose:@"BranchScene continueUserActivity" error:nil];
 

diff --git a/Sources/BranchSDK/Public/Branch.h b/Sources/BranchSDK/Public/Branch.h
@@ -437,6 +437,9 @@ extern NSString * __nonnull const BNCSpotlightFeature;
 
 - (void)initSceneSessionWithLaunchOptions:(NSDictionary *)options isReferrable:(BOOL)isReferrable explicitlyRequestedReferrable:(BOOL)explicitlyRequestedReferrable automaticallyDisplayController:(BOOL)automaticallyDisplayController
                   registerDeepLinkHandler:(void (^)(BNCInitSessionResponse * _Nullable initResponse, NSError * _Nullable error))callback;
+
+- (void)initSceneSessionWithLaunchOptions:(NSDictionary *)options sceneIdentifier:(NSString *)sceneIdentifier isReferrable:(BOOL)isReferrable explicitlyRequestedReferrable:(BOOL)explicitlyRequestedReferrable automaticallyDisplayController:(BOOL)automaticallyDisplayController
+                  registerDeepLinkHandler:(void (^)(BNCInitSessionResponse * _Nullable initResponse, NSError * _Nullable error))callback;
 /**
  Allow Branch to handle a link opening the app, returning whether it was from a Branch link or not.
 

diff --git a/Sources/BranchSDK/Public/BranchScene.h b/Sources/BranchSDK/Public/BranchScene.h
@@ -20,8 +20,10 @@ API_AVAILABLE(ios(13.0), macCatalyst(13.1))
 + (BranchScene *)shared;
 
 - (void)initSessionWithLaunchOptions:(nullable NSDictionary *)options
+             registerDeepLinkHandler:(void (^ _Nonnull)(NSDictionary * _Nullable params, NSError * _Nullable error, UIScene * _Nullable scene))callback __attribute__((deprecated(("Use `initSessionWithSceneOptions:scene:registerDeepLinkHandler:` instead."))));
+- (void)initSessionWithSceneOptions:(nullable UISceneConnectionOptions *)options
+                              scene:(UIScene *)scene
              registerDeepLinkHandler:(void (^ _Nonnull)(NSDictionary * _Nullable params, NSError * _Nullable error, UIScene * _Nullable scene))callback;
-
 - (void)scene:(UIScene *)scene continueUserActivity:(NSUserActivity *)userActivity;
 
 - (void)scene:(UIScene *)scene openURLContexts:(NSSet<UIOpenURLContext *> *)URLContexts;