CORE-1768 api for ATT prompt performance

Author: echo-branch

Branch-SDK/Branch.h

@@ -683,6 +683,16 @@ typedef NS_ENUM(NSUInteger, BranchCreditHistoryOrder) {
  */
 - (void)setAppClipAppGroup:(NSString *)appGroup;
 
+/**
+ Pass the AppTrackingTransparency authorization status to Branch to measure ATT prompt performance.
+ This method should be called from the callback of ATTrackingManager.requestTrackingAuthorization.
+ 
+ Note:
+ Before prompting the user, check that ATTrackingManager.trackingAuthorizationStatus is notDetermined.
+ Otherwise the prompt will not display and the completion will be called with current status. This will inflate the number of events shown in the Branch Dashboard.
+ */
+- (void)handleOptInStatus:(unsigned long)status;
+
 /**
  Set time window for SKAdNetwork callouts.  By default, Branch limits calls to SKAdNetwork to within 24 hours after first install.
  
@@ -694,7 +704,7 @@ typedef NS_ENUM(NSUInteger, BranchCreditHistoryOrder) {
  Add a Partner Parameter for Facebook.
  Once set, this parameter is attached to install, opens and events until cleared or the app restarts.
  
- See Facebook's documentation for details on valid parameters
+ See Facebook's documentation for details on valid parameters0
  */
 - (void)addFacebookPartnerParameterWithName:(NSString *)name value:(NSString *)value;
 

Branch-SDK/Branch.m

@@ -44,6 +44,7 @@
 #import "BNCSKAdNetwork.h"
 #import "BNCAppGroupsData.h"
 #import "BNCPartnerParameters.h"
+#import "BranchEvent.h"
 
 #if !TARGET_OS_TV
 #import "BNCUserAgentCollector.h"
@@ -969,6 +970,25 @@ - (void)setAppClipAppGroup:(NSString *)appGroup {
     [BNCAppGroupsData shared].appGroup = appGroup;
 }
 
+- (void)handleOptInStatus:(unsigned long)status {
+    BranchEvent *event;
+    switch (status) {
+        case 2:
+            // denied
+            event = [BranchEvent standardEvent:BranchStandardEventOptOut];
+            break;
+        case 3:
+            // authorized
+            event = [BranchEvent standardEvent:BranchStandardEventOptIn];
+            break;
+        default:
+            break;
+    }
+    if (event) {
+        [event logEvent];
+    }
+}
+
 - (void)setSKAdNetworkCalloutMaxTimeSinceInstall:(NSTimeInterval)maxTimeInterval {
     [BNCSKAdNetwork sharedInstance].maxTimeSinceInstall = maxTimeInterval;
 }

Branch-SDK/BranchEvent.h

@@ -45,6 +45,8 @@ FOUNDATION_EXPORT BranchStandardEvent _Nonnull BranchStandardEventUnlockAchievem
 FOUNDATION_EXPORT BranchStandardEvent _Nonnull BranchStandardEventInvite;
 FOUNDATION_EXPORT BranchStandardEvent _Nonnull BranchStandardEventLogin;
 FOUNDATION_EXPORT BranchStandardEvent _Nonnull BranchStandardEventReserve;
+FOUNDATION_EXPORT BranchStandardEvent _Nonnull  BranchStandardEventOptIn;
+FOUNDATION_EXPORT BranchStandardEvent _Nonnull  BranchStandardEventOptOut;
 
 typedef NS_ENUM(NSInteger, BranchEventAdType) {
     BranchEventAdTypeNone,

Branch-SDK/BranchEvent.m

@@ -46,6 +46,8 @@
 BranchStandardEvent BranchStandardEventInvite                 = @"INVITE";
 BranchStandardEvent BranchStandardEventLogin                  = @"LOGIN";
 BranchStandardEvent BranchStandardEventReserve                = @"RESERVE";
+BranchStandardEvent BranchStandardEventOptIn                  = @"OPT_IN";
+BranchStandardEvent BranchStandardEventOptOut                 = @"OPT_OUT";
 
 @implementation BranchEventRequest