Change the conflict configuration case into returning NSError instead of throwing exception

Author: bladewangqi

AdobeBranchExtension/Classes/AdobeBranchExtensionClass.h

@@ -23,6 +23,11 @@ FOUNDATION_EXPORT NSString*const ABEBranchEventType;
 /// Branch extension event source
 FOUNDATION_EXPORT NSString*const ABEBranchEventSource;
 
+/// Branch extension error code
+typedef NS_ENUM(NSInteger, ABEBranchErrorCode) {
+    ABEBranchConflictConfiguration  = 2000,
+};
+
 /**
  This is the class defines the root Adobe / Branch integration for deep linking and events.
  */
@@ -36,9 +41,9 @@ FOUNDATION_EXPORT NSString*const ABEBranchEventSource;
 
 + (void)configureEventTypes:(nullable NSArray<NSString *> *)eventTypes andEventSources:(nullable NSArray<NSString *> *)eventSources;
 
-+ (void)configureEventExclusionList:(nullable NSArray<NSString *> *)eventNames;
++ (BOOL)configureEventExclusionList:(nullable NSArray<NSString *> *)eventNames error:(NSError * __autoreleasing *)configError;
 
-+ (void)configureEventAllowList:(nullable NSArray<NSString *> *)eventNames;
++ (BOOL)configureEventAllowList:(nullable NSArray<NSString *> *)eventNames error:(NSError * __autoreleasing *)configError;
 
 - (void)handleEvent:(ACPExtensionEvent*)event;
 

AdobeBranchExtension/Classes/AdobeBranchExtensionClass.m

@@ -16,6 +16,9 @@
 NSString*const ABEBranchEventType               = @"com.branch.eventType";
 NSString*const ABEBranchEventSource             = @"com.branch.eventSource";
 
+// Adobe Launch Branch extension error domain
+NSString*const AdobeBranchExtensionErrorDomain  = @"io.branch.adobe_launch_extension.error";
+
 // 1. events of this type and source
 NSString *const ABEAdobeHubEventType = @"com.adobe.eventType.hub";
 NSString *const ABEAdobeSharedStateEventSource = @"com.adobe.eventSource.sharedState";
@@ -93,32 +96,32 @@ + (void)configureEventTypes:(nullable NSArray<NSString *> *)eventTypes andEventS
     }
 }
 
-+ (void)configureEventExclusionList:(nullable NSArray<NSString *> *)eventNames {
++ (BOOL)configureEventExclusionList:(nullable NSArray<NSString *> *)eventNames error:(NSError * __autoreleasing *)configError {
     if (eventNames) {
         // If already configured allowList
         if ([AdobeBranchExtensionConfig instance].allowList.count != 0) {
-            @throw [NSException
-                        exceptionWithName:@"ConflictConfiguration"
-                        reason:@"Already configured allowList for AdobeBranchExtensionConfig"
-                        userInfo:nil];
+            *configError = [NSError errorWithDomain:AdobeBranchExtensionErrorDomain code:ABEBranchConflictConfiguration userInfo:@{NSLocalizedFailureReasonErrorKey: @"Already configured allowList for AdobeBranchExtensionConfig"}];
+            BNCLogError([NSString stringWithFormat:@"AdobeBranchExtensionConfig error: %@.", *configError]);
+            return NO;
         } else {
             [AdobeBranchExtensionConfig instance].exclusionList = eventNames;
         }
     }
+    return YES;
 }
 
-+ (void)configureEventAllowList:(nullable NSArray<NSString *> *)eventNames {
++ (BOOL)configureEventAllowList:(nullable NSArray<NSString *> *)eventNames error:(NSError * __autoreleasing *)configError {
     if (eventNames) {
         // If already configured allowList
         if ([AdobeBranchExtensionConfig instance].exclusionList.count != 0) {
-            @throw [NSException
-                        exceptionWithName:@"ConflictConfiguration"
-                        reason:@"Already configured exclusionList for AdobeBranchExtensionConfig"
-                        userInfo:nil];
+            *configError = [NSError errorWithDomain:AdobeBranchExtensionErrorDomain code:ABEBranchConflictConfiguration userInfo:@{NSLocalizedFailureReasonErrorKey: @"Already configured exclusionList for AdobeBranchExtensionConfig"}];
+            BNCLogError([NSString stringWithFormat:@"AdobeBranchExtensionConfig error: %@.", *configError]);
+            return NO;
         } else {
             [AdobeBranchExtensionConfig instance].allowList = eventNames;
         }
     }
+    return YES;
 }
 
 - (instancetype)init {

Examples/AdobeBranchExample/AdobeBranchExample/AppDelegate.m

@@ -48,9 +48,17 @@ - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(
 
     // NOTE! following code will enable you to configure exclusion list or allow list, but you can't define both! If you don't configure any, all events will send to Branch which is not ideal!
     // Define the exclusion list of the events names
-//    [AdobeBranchExtension configureEventExclusionList:@[@"VIEW"]];
+//    if ([AdobeBranchExtension configureEventExclusionList:@[@"VIEW"] error:&error]) {
+//        NSLog(@"AdobeBranchExtension AllowList configured");
+//    } else {
+//        NSLog(@"%@", error);
+//    }
     // Define the allow list of the events names
-    [AdobeBranchExtension configureEventAllowList:@[@"VIEW"]];
+    if ([AdobeBranchExtension configureEventAllowList:@[@"VIEW"] error:&error]) {
+        NSLog(@"AdobeBranchExtension AllowList configured");
+    } else {
+        NSLog(@"%@", error);
+    }
     // register AdobeBranchExtension
     if ([ACPCore registerExtension:[AdobeBranchExtension class] error:&error]) {
         NSLog(@"AdobeBranchExtension Registered");