[release] 1.39.2

Author: branch-sdkteam

Branch-SDK/BNCConfig.m

@@ -11,4 +11,4 @@
 NSString * const BNC_API_BASE_URL    = @"https://api2.branch.io";
 NSString * const BNC_API_VERSION     = @"v1";
 NSString * const BNC_LINK_URL        = @"https://bnc.lt";
-NSString * const BNC_SDK_VERSION     = @"1.39.1";
+NSString * const BNC_SDK_VERSION     = @"1.39.2";

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/BNCSystemObserver.m

@@ -128,7 +128,7 @@ + (NSString *)attOptedInStatus {
     return statusString;
 }
 
-// on iOS 14+ this value is always NO
+// this value is deprecated on iOS 14+
 + (BOOL)adTrackingSafe {
     #ifdef BRANCH_EXCLUDE_IDFA_CODE
     return NO;

Branch-SDK/Branch.h

@@ -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,32 @@ - (void)setAppClipAppGroup:(NSString *)appGroup {
     [BNCAppGroupsData shared].appGroup = appGroup;
 }
 
+- (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:
+            // 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/Branch.m

@@ -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.h

@@ -46,6 +46,8 @@
 BranchStandardEvent BranchStandardEventInvite                 = @"INVITE";
 BranchStandardEvent BranchStandardEventLogin                  = @"LOGIN";
 BranchStandardEvent BranchStandardEventReserve                = @"RESERVE";
+BranchStandardEvent BranchStandardEventOptIn                  = @"OPT_IN";
+BranchStandardEvent BranchStandardEventOptOut                 = @"OPT_OUT";
 
 @implementation BranchEventRequest
 
@@ -226,6 +228,8 @@ - (NSDictionary*) dictionary {
         BranchStandardEventStartTrial,
         BranchStandardEventClickAd,
         BranchStandardEventViewAd,
+        BranchStandardEventOptOut,
+        BranchStandardEventOptIn,
     ];
 }
 

Branch-SDK/BranchEvent.m

@@ -641,6 +641,50 @@ - (void)testCustomViewAdEvent {
     XCTAssert([request.serverURL.absoluteString containsString:@"branch.io/v2/event/standard"]);
 }
 
+- (void)testStandardOptInEvent {
+    BranchEvent *event = [BranchEvent standardEvent:BranchStandardEventOptIn];
+    
+    NSDictionary *eventDictionary = [event buildEventDictionary];
+    XCTAssertNotNil(eventDictionary);
+    XCTAssert([eventDictionary[@"name"] isEqualToString:@"OPT_IN"]);
+    
+    BranchEventRequest *request = [event buildRequestWithEventDictionary:eventDictionary];
+    XCTAssert([request.serverURL.absoluteString containsString:@"branch.io/v2/event/standard"]);
+}
+
+- (void)testCustomOptInEvent {
+    BranchEvent *event = [BranchEvent customEventWithName:@"OPT_IN"];
+    
+    NSDictionary *eventDictionary = [event buildEventDictionary];
+    XCTAssertNotNil(eventDictionary);
+    XCTAssert([eventDictionary[@"name"] isEqualToString:@"OPT_IN"]);
+    
+    BranchEventRequest *request = [event buildRequestWithEventDictionary:eventDictionary];
+    XCTAssert([request.serverURL.absoluteString containsString:@"branch.io/v2/event/standard"]);
+}
+
+- (void)testStandardOptOutEvent {
+    BranchEvent *event = [BranchEvent standardEvent:BranchStandardEventOptOut];
+    
+    NSDictionary *eventDictionary = [event buildEventDictionary];
+    XCTAssertNotNil(eventDictionary);
+    XCTAssert([eventDictionary[@"name"] isEqualToString:@"OPT_OUT"]);
+    
+    BranchEventRequest *request = [event buildRequestWithEventDictionary:eventDictionary];
+    XCTAssert([request.serverURL.absoluteString containsString:@"branch.io/v2/event/standard"]);
+}
+
+- (void)testCustomOptOutEvent {
+    BranchEvent *event = [BranchEvent customEventWithName:@"OPT_OUT"];
+    
+    NSDictionary *eventDictionary = [event buildEventDictionary];
+    XCTAssertNotNil(eventDictionary);
+    XCTAssert([eventDictionary[@"name"] isEqualToString:@"OPT_OUT"]);
+    
+    BranchEventRequest *request = [event buildRequestWithEventDictionary:eventDictionary];
+    XCTAssert([request.serverURL.absoluteString containsString:@"branch.io/v2/event/standard"]);
+}
+
 - (void)testJsonStringForAdTypeNone {
     BranchEvent *event = [BranchEvent standardEvent:BranchStandardEventViewAd];
     XCTAssertNil([event jsonStringForAdType:BranchEventAdTypeNone]);

Branch-TestBed/Branch-SDK-Tests/BranchEvent.Test.m

@@ -17,11 +17,11 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>1.39.1</string>
+	<string>1.39.2</string>
 	<key>CFBundleSignature</key>
 	<string>????</string>
 	<key>CFBundleVersion</key>
-	<string>1.39.1</string>
+	<string>1.39.2</string>
 	<key>LSRequiresIPhoneOS</key>
 	<true/>
 	<key>NSHumanReadableCopyright</key>