Merge pull request #1105 from BranchMetrics/CORE-1768-rename-api-for-better-readability,-add-safety-check

CORE-1768 rename api for better readability, add safety check

Author: echo-branch

Branch-SDK/BNCPreferenceHelper.h

@@ -37,6 +37,7 @@ NSURL* /* _Nonnull */ BNCURLForBranchDirectory(void);
 @property (assign, nonatomic) BOOL checkedAppleSearchAdAttribution;
 @property (nonatomic, assign, readwrite) BOOL appleAttributionTokenChecked;
 @property (nonatomic, assign, readwrite) BOOL hasOptedInBefore;
+@property (nonatomic, assign, readwrite) BOOL hasCalledHandleATTAuthorizationStatus;
 @property (assign, nonatomic) NSInteger retryCount;
 @property (assign, nonatomic) NSTimeInterval retryInterval;
 @property (assign, nonatomic) NSTimeInterval timeout;

Branch-SDK/BNCPreferenceHelper.m

@@ -400,6 +400,14 @@ - (BOOL)hasOptedInBefore {
     return [self readBoolFromDefaults:@"_hasOptedInBefore"];
 }
 
+- (void)setHasCalledHandleATTAuthorizationStatus:(BOOL)hasCalledHandleATTAuthorizationStatus {
+    [self writeBoolToDefaults:@"_hasCalledHandleATTAuthorizationStatus" value:hasCalledHandleATTAuthorizationStatus];
+}
+
+- (BOOL)hasCalledHandleATTAuthorizationStatus {
+    return [self readBoolFromDefaults:@"_hasCalledHandleATTAuthorizationStatus"];
+}
+
 - (NSString*) lastSystemBuildVersion {
     if (!_lastSystemBuildVersion) {
         _lastSystemBuildVersion = [self readStringFromDefaults:@"_lastSystemBuildVersion"];

Branch-SDK/Branch.h

@@ -692,7 +692,7 @@ typedef NS_ENUM(NSUInteger, BranchCreditHistoryOrder) {
  Otherwise the prompt will not display and the completion will be called with current status.
  This will inflate the number of OPT_IN and OPT_OUT events tracked by Branch.
  */
-- (void)handleOptInStatus:(NSUInteger)status;
+- (void)handleATTAuthorizationStatus:(NSUInteger)status;
 
 /**
  Set time window for SKAdNetwork callouts.  By default, Branch limits calls to SKAdNetwork to within 24 hours after first install.

Branch-SDK/Branch.m

@@ -970,7 +970,14 @@ - (void)setAppClipAppGroup:(NSString *)appGroup {
     [BNCAppGroupsData shared].appGroup = appGroup;
 }
 
-- (void)handleOptInStatus:(NSUInteger)status {
+- (void)handleATTAuthorizationStatus:(NSUInteger)status {
+    // limits impact if the client fails to check that status = notDetermined before calling
+    if ([BNCPreferenceHelper preferenceHelper].hasCalledHandleATTAuthorizationStatus) {
+        return;
+    } else {
+        [BNCPreferenceHelper preferenceHelper].hasCalledHandleATTAuthorizationStatus = YES;
+    }
+    
     BranchEvent *event;
     switch (status) {
         case 2: