change userSubscriptionSetting to isPushDisabled

Matching iOS and Android state property names

Author: emawby

iOS_SDK/OneSignalSDK/Source/OSDeviceState.m

@@ -42,7 +42,7 @@ - (instancetype)initWithSubscriptionState:(OSPermissionSubscriptionState *)state
     if (self) {
         _hasNotificationPermission = [[state permissionStatus] reachable];
 
-        _isPushDisabled = ![[state subscriptionStatus] userSubscriptionSetting];
+        _isPushDisabled = [[state subscriptionStatus] isPushDisabled];
 
         _isSubscribed = [[state subscriptionStatus] isSubscribed];
 

iOS_SDK/OneSignalSDK/Source/OSSubscription.h

@@ -45,13 +45,13 @@ typedef OSObservable<NSObject<OSSubscriptionStateObserver>*, OSSubscriptionState
 
 // Redefine OSSubscriptionState
 @interface OSSubscriptionState () {
-@protected BOOL _userSubscriptionSetting;
+@protected BOOL _isPushDisabled;
 @protected NSString* _userId;
 @protected NSString* _pushToken;
 }
 
 // @property (readonly, nonatomic) BOOL subscribed; // (yes only if userId, pushToken, and setSubscription exists / are true)
-@property (readwrite, nonatomic) BOOL userSubscriptionSetting; // returns setSubscription state.
+@property (readwrite, nonatomic) BOOL isPushDisabled; // returns value of disablePush.
 @property (readwrite, nonatomic) NSString* userId;    // AKA OneSignal PlayerId
 @property (readwrite, nonatomic) NSString* pushToken; // AKA Apple Device Token
 @property (nonatomic) ObservableSubscriptionStateType* observable;

iOS_SDK/OneSignalSDK/Source/OSSubscription.m

@@ -47,15 +47,15 @@ - (instancetype)initAsToWithPermision:(BOOL)permission {
     let standardUserDefaults = OneSignalUserDefaults.initStandard;
     _userId = [standardUserDefaults getSavedStringForKey:OSUD_PLAYER_ID_TO defaultValue:nil];
     _pushToken = [standardUserDefaults getSavedStringForKey:OSUD_PUSH_TOKEN_TO defaultValue:nil];
-    _userSubscriptionSetting = ![standardUserDefaults keyExists:OSUD_USER_SUBSCRIPTION_TO];
+    _isPushDisabled = [standardUserDefaults keyExists:OSUD_USER_SUBSCRIPTION_TO];
 
     return self;
 }
 
 - (BOOL)compare:(OSSubscriptionState*)from {
     return ![self.userId ?: @"" isEqualToString:from.userId ?: @""] ||
            ![self.pushToken ?: @"" isEqualToString:from.pushToken ?: @""] ||
-           self.userSubscriptionSetting != from.userSubscriptionSetting ||
+           self.isPushDisabled != from.isPushDisabled ||
            self.accpeted != from.accpeted;
 }
 
@@ -64,14 +64,14 @@ - (instancetype)initAsFrom {
     _accpeted = [standardUserDefaults getSavedBoolForKey:OSUD_PERMISSION_ACCEPTED_FROM defaultValue:false];
     _userId = [standardUserDefaults getSavedStringForKey:OSUD_PLAYER_ID_FROM defaultValue:nil];
     _pushToken = [standardUserDefaults getSavedStringForKey:OSUD_PUSH_TOKEN_FROM defaultValue:nil];
-    _userSubscriptionSetting = ![standardUserDefaults keyExists:OSUD_USER_SUBSCRIPTION_FROM];
+    _isPushDisabled = [standardUserDefaults keyExists:OSUD_USER_SUBSCRIPTION_FROM];
 
     return self;
 }
 
 - (void)persistAsFrom {
     NSString* strUserSubscriptionSetting = nil;
-    if (!_userSubscriptionSetting)
+    if (_isPushDisabled)
         strUserSubscriptionSetting = @"no";
 
     let standardUserDefaults = OneSignalUserDefaults.initStandard;
@@ -87,7 +87,7 @@ - (instancetype)copyWithZone:(NSZone*)zone {
     if (copy) {
         copy->_userId = [_userId copy];
         copy->_pushToken = [_pushToken copy];
-        copy->_userSubscriptionSetting = _userSubscriptionSetting;
+        copy->_isPushDisabled = _isPushDisabled;
         copy->_accpeted = _accpeted;
     }
 
@@ -116,9 +116,9 @@ - (void)setPushToken:(NSString*)pushToken {
     }
 }
 
-- (void)setUserSubscriptionSetting:(BOOL)userSubscriptionSetting {
-    BOOL changed = userSubscriptionSetting != _userSubscriptionSetting;
-    _userSubscriptionSetting = userSubscriptionSetting;
+- (void)setIsPushDisabled:(BOOL)isPushDisabled {
+    BOOL changed = isPushDisabled != _isPushDisabled;
+    _isPushDisabled = isPushDisabled;
     if (self.observable && changed)
         [self.observable notifyChange:self];
 }
@@ -142,20 +142,20 @@ - (void)setAccepted:(BOOL)inAccpeted {
 }
 
 - (BOOL)isSubscribed {
-    return _userId && _pushToken && _userSubscriptionSetting && _accpeted;
+    return _userId && _pushToken && !_isPushDisabled && _accpeted;
 }
 
 - (NSString*)description {
     static NSString* format = @"<OSSubscriptionState: userId: %@, pushToken: %@, userSubscriptionSetting: %d, subscribed: %d>";
-    return [NSString stringWithFormat:format, self.userId, self.pushToken, self.userSubscriptionSetting, self.isSubscribed];
+    return [NSString stringWithFormat:format, self.userId, self.pushToken, self.isPushDisabled, self.isSubscribed];
 }
 
 - (NSDictionary*)toDictionary {
     return @{
          @"userId": _userId ?: [NSNull null],
          @"pushToken": _pushToken ?: [NSNull null],
-         @"userSubscriptionSetting": @(_userSubscriptionSetting),
-         @"subscribed": @(self.isSubscribed)
+         @"isPushDisabled": @(_isPushDisabled),
+         @"isSubscribed": @(self.isSubscribed)
      };
 }
 

iOS_SDK/OneSignalSDK/Source/OneSignal.h

@@ -288,7 +288,7 @@ typedef NS_ENUM(NSInteger, OSNotificationPermission) {
 @interface OSSubscriptionState : NSObject
 
 @property (readonly, nonatomic) BOOL isSubscribed; // (yes only if userId, pushToken, and setSubscription exists / are true)
-@property (readonly, nonatomic) BOOL userSubscriptionSetting; // returns setSubscription state.
+@property (readonly, nonatomic) BOOL isPushDisabled; // returns value of disablePush.
 @property (readonly, nonatomic, nullable) NSString* userId;    // AKA OneSignal PlayerId
 @property (readonly, nonatomic, nullable) NSString* pushToken; // AKA Apple Device Token
 - (NSDictionary* _Nonnull)toDictionary;

iOS_SDK/OneSignalSDK/Source/OneSignal.m

@@ -1379,7 +1379,7 @@ + (void)enableInAppLaunchURL:(BOOL)enable {
 
 + (void)disablePush:(BOOL)disable {
     // return if the user has not granted privacy permissions
-    if ([self shouldLogMissingPrivacyConsentErrorWithMethodName:@"setSubscription:"])
+    if ([self shouldLogMissingPrivacyConsentErrorWithMethodName:@"disablePush:"])
         return;
 
     NSString* value = nil;
@@ -1390,7 +1390,7 @@ + (void)disablePush:(BOOL)disable {
 
     shouldDelaySubscriptionUpdate = true;
 
-    self.currentSubscriptionState.userSubscriptionSetting = !disable;
+    self.currentSubscriptionState.isPushDisabled = disable;
 
     if (appId)
         [OneSignal sendNotificationTypesUpdate];
@@ -2096,7 +2096,7 @@ + (int)getNotificationTypes {
     if (!permissionStatus.provisional && !permissionStatus.answeredPrompt)
         return ERROR_PUSH_PROMPT_NEVER_ANSWERED;
 
-    if (!self.currentSubscriptionState.userSubscriptionSetting)
+    if (self.currentSubscriptionState.isPushDisabled)
         return -2;
 
     return permissionStatus.notificationTypes;

iOS_SDK/OneSignalSDK/UnitTests/UnitTests.m

@@ -184,7 +184,7 @@ - (void)testBasicInitTest {
     NSLog(@"CURRENT USER ID: %@", status.subscriptionStatus);
 
     XCTAssertEqual(status.subscriptionStatus.isSubscribed, true);
-    XCTAssertEqual(status.subscriptionStatus.userSubscriptionSetting, true);
+    XCTAssertEqual(status.subscriptionStatus.isPushDisabled, false);
     XCTAssertEqual(status.subscriptionStatus.userId, @"1234");
     XCTAssertEqualObjects(status.subscriptionStatus.pushToken, @"0000000000000000000000000000000000000000000000000000000000000000");
 
@@ -617,8 +617,8 @@ - (void)testSubscriptionChangeObserverWhenPromptNotShown {
     [OneSignal disablePush:true];
     [UnitTestCommonMethods runBackgroundThreads];
 
-    XCTAssertTrue(observer->last.from.userSubscriptionSetting);
-    XCTAssertFalse(observer->last.to.userSubscriptionSetting);
+    XCTAssertFalse(observer->last.from.isPushDisabled);
+    XCTAssertTrue(observer->last.to.isPushDisabled);
     // Device registered with OneSignal so now make pushToken available.
     XCTAssertEqualObjects(observer->last.to.pushToken, @"0000000000000000000000000000000000000000000000000000000000000000");
 
@@ -1818,8 +1818,8 @@ - (void)testPushNotificationToken {
     [OneSignal disablePush:false];
     [UnitTestCommonMethods runBackgroundThreads];
 
-    XCTAssertFalse(observer->last.from.userSubscriptionSetting);
-    XCTAssertFalse(observer->last.to.userSubscriptionSetting);
+    XCTAssertFalse(observer->last.from.isPushDisabled);
+    XCTAssertFalse(observer->last.to.isPushDisabled);
     // Device registered with OneSignal so now make pushToken available.
     XCTAssertNil(observer->last.to.pushToken);