Skip to content

Commit b5bd926

Browse files
emawbyemawby
authored
Merge pull request #779 from OneSignal/android_ios_property_name_match
Matching iOS and Android state class property names
2 parents 83adb31 + ae55a0c commit b5bd926

File tree

10 files changed

+71
-62
lines changed

10 files changed

+71
-62
lines changed

‎iOS_SDK/OneSignalDevApp/OneSignalDevApp/AppDelegate.m‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ - (void) onOSPermissionChanged:(OSPermissionStateChanges*)stateChanges {
121121
- (void) onOSSubscriptionChanged:(OSSubscriptionStateChanges*)stateChanges {
122122
NSLog(@"onOSSubscriptionChanged: %@", stateChanges);
123123
ViewController* mainController = (ViewController*) self.window.rootViewController;
124-
mainController.subscriptionSegmentedControl.selectedSegmentIndex = (NSInteger) stateChanges.to.subscribed;
124+
mainController.subscriptionSegmentedControl.selectedSegmentIndex = (NSInteger) stateChanges.to.isSubscribed;
125125
}
126126

127127
- (void)onOSEmailSubscriptionChanged:(OSEmailSubscriptionStateChanges *)stateChanges {

‎iOS_SDK/OneSignalDevApp/OneSignalDevAppClip/AppDelegate.m‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ - (void) onOSPermissionChanged:(OSPermissionStateChanges*)stateChanges {
118118
- (void) onOSSubscriptionChanged:(OSSubscriptionStateChanges*)stateChanges {
119119
NSLog(@"onOSSubscriptionChanged: %@", stateChanges);
120120
ViewController* mainController = (ViewController*) self.window.rootViewController;
121-
mainController.subscriptionSegmentedControl.selectedSegmentIndex = (NSInteger) stateChanges.to.subscribed;
121+
mainController.subscriptionSegmentedControl.selectedSegmentIndex = (NSInteger) stateChanges.to.isSubscribed;
122122
}
123123

124124
- (void)onOSEmailSubscriptionChanged:(OSEmailSubscriptionStateChanges *)stateChanges {

‎iOS_SDK/OneSignalSDK/Source/OSDeviceState.m‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,9 @@ - (instancetype)initWithSubscriptionState:(OSPermissionSubscriptionState *)state
4242
if (self) {
4343
_hasNotificationPermission = [[state permissionStatus] reachable];
4444

45-
_isPushDisabled = ![[state subscriptionStatus] userSubscriptionSetting];
45+
_isPushDisabled = [[state subscriptionStatus] isPushDisabled];
4646

47-
_isSubscribed = [[state subscriptionStatus] subscribed];
47+
_isSubscribed = [[state subscriptionStatus] isSubscribed];
4848

4949
_notificationPermissionStatus = [[state permissionStatus] status];
5050

@@ -55,6 +55,8 @@ - (instancetype)initWithSubscriptionState:(OSPermissionSubscriptionState *)state
5555
_emailUserId = [[state emailSubscriptionStatus] emailUserId];
5656

5757
_emailAddress = [[state emailSubscriptionStatus] emailAddress];
58+
59+
_isEmailSubscribed = [[state emailSubscriptionStatus] isSubscribed];
5860
}
5961
return self;
6062
}
@@ -70,6 +72,7 @@ - (NSDictionary *_Nonnull)jsonRepresentation {
7072
json[@"pushToken"] = _pushToken;
7173
json[@"emailUserId"] = _emailUserId;
7274
json[@"emailAddress"] = _emailAddress;
75+
json[@"isEmailSubscribed"] = @(_isEmailSubscribed);
7376
json[@"notificationPermissionStatus"] = @(_notificationPermissionStatus);
7477

7578
return json;

‎iOS_SDK/OneSignalSDK/Source/OSEmailSubscription.m‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ - (instancetype)init {
4848
return self;
4949
}
5050

51-
-(BOOL)subscribed {
51+
-(BOOL)isSubscribed {
5252
return self.emailUserId != nil;
5353
}
5454

‎iOS_SDK/OneSignalSDK/Source/OSSubscription.h‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,13 +45,13 @@ typedef OSObservable<NSObject<OSSubscriptionStateObserver>*, OSSubscriptionState
4545

4646
// Redefine OSSubscriptionState
4747
@interface OSSubscriptionState () {
48-
@protected BOOL _userSubscriptionSetting;
48+
@protected BOOL _isPushDisabled;
4949
@protected NSString* _userId;
5050
@protected NSString* _pushToken;
5151
}
5252

5353
// @property (readonly, nonatomic) BOOL subscribed; // (yes only if userId, pushToken, and setSubscription exists / are true)
54-
@property (readwrite, nonatomic) BOOL userSubscriptionSetting; // returns setSubscription state.
54+
@property (readwrite, nonatomic) BOOL isPushDisabled; // returns value of disablePush.
5555
@property (readwrite, nonatomic) NSString* userId; // AKA OneSignal PlayerId
5656
@property (readwrite, nonatomic) NSString* pushToken; // AKA Apple Device Token
5757
@property (nonatomic) ObservableSubscriptionStateType* observable;

‎iOS_SDK/OneSignalSDK/Source/OSSubscription.m‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -47,15 +47,15 @@ - (instancetype)initAsToWithPermision:(BOOL)permission {
4747
let standardUserDefaults = OneSignalUserDefaults.initStandard;
4848
_userId = [standardUserDefaults getSavedStringForKey:OSUD_PLAYER_ID_TO defaultValue:nil];
4949
_pushToken = [standardUserDefaults getSavedStringForKey:OSUD_PUSH_TOKEN_TO defaultValue:nil];
50-
_userSubscriptionSetting = ![standardUserDefaults keyExists:OSUD_USER_SUBSCRIPTION_TO];
50+
_isPushDisabled = [standardUserDefaults keyExists:OSUD_USER_SUBSCRIPTION_TO];
5151

5252
return self;
5353
}
5454

5555
- (BOOL)compare:(OSSubscriptionState*)from {
5656
return ![self.userId ?: @"" isEqualToString:from.userId ?: @""] ||
5757
![self.pushToken ?: @"" isEqualToString:from.pushToken ?: @""] ||
58-
self.userSubscriptionSetting != from.userSubscriptionSetting ||
58+
self.isPushDisabled != from.isPushDisabled ||
5959
self.accpeted != from.accpeted;
6060
}
6161

@@ -64,14 +64,14 @@ - (instancetype)initAsFrom {
6464
_accpeted = [standardUserDefaults getSavedBoolForKey:OSUD_PERMISSION_ACCEPTED_FROM defaultValue:false];
6565
_userId = [standardUserDefaults getSavedStringForKey:OSUD_PLAYER_ID_FROM defaultValue:nil];
6666
_pushToken = [standardUserDefaults getSavedStringForKey:OSUD_PUSH_TOKEN_FROM defaultValue:nil];
67-
_userSubscriptionSetting = ![standardUserDefaults keyExists:OSUD_USER_SUBSCRIPTION_FROM];
67+
_isPushDisabled = ![standardUserDefaults getSavedBoolForKey:OSUD_USER_SUBSCRIPTION_FROM defaultValue:NO];
6868

6969
return self;
7070
}
7171

7272
- (void)persistAsFrom {
7373
NSString* strUserSubscriptionSetting = nil;
74-
if (!_userSubscriptionSetting)
74+
if (_isPushDisabled)
7575
strUserSubscriptionSetting = @"no";
7676

7777
let standardUserDefaults = OneSignalUserDefaults.initStandard;
@@ -87,7 +87,7 @@ - (instancetype)copyWithZone:(NSZone*)zone {
8787
if (copy) {
8888
copy->_userId = [_userId copy];
8989
copy->_pushToken = [_pushToken copy];
90-
copy->_userSubscriptionSetting = _userSubscriptionSetting;
90+
copy->_isPushDisabled = _isPushDisabled;
9191
copy->_accpeted = _accpeted;
9292
}
9393

@@ -116,16 +116,16 @@ - (void)setPushToken:(NSString*)pushToken {
116116
}
117117
}
118118

119-
- (void)setUserSubscriptionSetting:(BOOL)userSubscriptionSetting {
120-
BOOL changed = userSubscriptionSetting != _userSubscriptionSetting;
121-
_userSubscriptionSetting = userSubscriptionSetting;
119+
- (void)setIsPushDisabled:(BOOL)isPushDisabled {
120+
BOOL changed = isPushDisabled != _isPushDisabled;
121+
_isPushDisabled = isPushDisabled;
122122
if (self.observable && changed)
123123
[self.observable notifyChange:self];
124124
}
125125

126126

127127
- (void)setAccepted:(BOOL)inAccpeted {
128-
BOOL lastSubscribed = self.subscribed;
128+
BOOL lastSubscribed = self.isSubscribed;
129129

130130
// checks to see if we should delay the observer update
131131
// This is to prevent a problem where the observer gets updated
@@ -137,25 +137,25 @@ - (void)setAccepted:(BOOL)inAccpeted {
137137
}
138138

139139
_accpeted = inAccpeted;
140-
if (lastSubscribed != self.subscribed)
140+
if (lastSubscribed != self.isSubscribed)
141141
[self.observable notifyChange:self];
142142
}
143143

144-
- (BOOL)subscribed {
145-
return _userId && _pushToken && _userSubscriptionSetting && _accpeted;
144+
- (BOOL)isSubscribed {
145+
return _userId && _pushToken && !_isPushDisabled && _accpeted;
146146
}
147147

148148
- (NSString*)description {
149-
static NSString* format = @"<OSSubscriptionState: userId: %@, pushToken: %@, userSubscriptionSetting: %d, subscribed: %d>";
150-
return [NSString stringWithFormat:format, self.userId, self.pushToken, self.userSubscriptionSetting, self.subscribed];
149+
static NSString* format = @"<OSSubscriptionState: userId: %@, pushToken: %@, isPushDisabled: %d, isSubscribed: %d>";
150+
return [NSString stringWithFormat:format, self.userId, self.pushToken, self.isPushDisabled, self.isSubscribed];
151151
}
152152

153153
- (NSDictionary*)toDictionary {
154154
return @{
155155
@"userId": _userId ?: [NSNull null],
156156
@"pushToken": _pushToken ?: [NSNull null],
157-
@"userSubscriptionSetting": @(_userSubscriptionSetting),
158-
@"subscribed": @(self.subscribed)
157+
@"isPushDisabled": @(_isPushDisabled),
158+
@"isSubscribed": @(self.isSubscribed)
159159
};
160160
}
161161

‎iOS_SDK/OneSignalSDK/Source/OneSignal.h‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -287,8 +287,8 @@ typedef NS_ENUM(NSInteger, OSNotificationPermission) {
287287
// Subscription Classes
288288
@interface OSSubscriptionState : NSObject
289289

290-
@property (readonly, nonatomic) BOOL subscribed; // (yes only if userId, pushToken, and setSubscription exists / are true)
291-
@property (readonly, nonatomic) BOOL userSubscriptionSetting; // returns setSubscription state.
290+
@property (readonly, nonatomic) BOOL isSubscribed; // (yes only if userId, pushToken, and setSubscription exists / are true)
291+
@property (readonly, nonatomic) BOOL isPushDisabled; // returns value of disablePush.
292292
@property (readonly, nonatomic, nullable) NSString* userId; // AKA OneSignal PlayerId
293293
@property (readonly, nonatomic, nullable) NSString* pushToken; // AKA Apple Device Token
294294
- (NSDictionary* _Nonnull)toDictionary;
@@ -298,7 +298,7 @@ typedef NS_ENUM(NSInteger, OSNotificationPermission) {
298298
@interface OSEmailSubscriptionState : NSObject
299299
@property (readonly, nonatomic, nullable) NSString* emailUserId; // The new Email user ID
300300
@property (readonly, nonatomic, nullable) NSString *emailAddress;
301-
@property (readonly, nonatomic) BOOL subscribed;
301+
@property (readonly, nonatomic) BOOL isSubscribed;
302302
- (NSDictionary* _Nonnull)toDictionary;
303303
@end
304304

@@ -374,6 +374,8 @@ typedef NS_ENUM(NSInteger, OSNotificationPermission) {
374374
*/
375375
@property (readonly, nullable) NSString* emailAddress;
376376

377+
@property (readonly) BOOL isEmailSubscribed;
378+
377379
- (instancetype)initWithSubscriptionState:(OSPermissionSubscriptionState *)state;
378380

379381
// Convert the class into a NSDictionary

‎iOS_SDK/OneSignalSDK/Source/OneSignal.m‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1379,7 +1379,7 @@ + (void)enableInAppLaunchURL:(BOOL)enable {
13791379

13801380
+ (void)disablePush:(BOOL)disable {
13811381
// return if the user has not granted privacy permissions
1382-
if ([self shouldLogMissingPrivacyConsentErrorWithMethodName:@"setSubscription:"])
1382+
if ([self shouldLogMissingPrivacyConsentErrorWithMethodName:@"disablePush:"])
13831383
return;
13841384

13851385
NSString* value = nil;
@@ -1390,7 +1390,7 @@ + (void)disablePush:(BOOL)disable {
13901390

13911391
shouldDelaySubscriptionUpdate = true;
13921392

1393-
self.currentSubscriptionState.userSubscriptionSetting = !disable;
1393+
self.currentSubscriptionState.isPushDisabled = disable;
13941394

13951395
if (appId)
13961396
[OneSignal sendNotificationTypesUpdate];
@@ -2096,7 +2096,7 @@ + (int)getNotificationTypes {
20962096
if (!permissionStatus.provisional && !permissionStatus.answeredPrompt)
20972097
return ERROR_PUSH_PROMPT_NEVER_ANSWERED;
20982098

2099-
if (!self.currentSubscriptionState.userSubscriptionSetting)
2099+
if (self.currentSubscriptionState.isPushDisabled)
21002100
return -2;
21012101

21022102
return permissionStatus.notificationTypes;

‎iOS_SDK/OneSignalSDK/UnitTests/EmailTests.m‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -296,7 +296,7 @@ - (void)testSubscriptionState {
296296
XCTAssertNil(unsubscribedSubscriptionStatus.emailAuthCode);
297297
XCTAssertNil(unsubscribedSubscriptionStatus.emailAddress);
298298
XCTAssertNil(unsubscribedSubscriptionStatus.emailUserId);
299-
XCTAssertFalse(unsubscribedSubscriptionStatus.subscribed);
299+
XCTAssertFalse(unsubscribedSubscriptionStatus.isSubscribed);
300300

301301
let expectation = [self expectationWithDescription:@"email"];
302302
expectation.expectedFulfillmentCount = 2;
@@ -312,7 +312,7 @@ - (void)testSubscriptionState {
312312
XCTAssertEqual(loggedInSubscriptionStatus.emailUserId, @"1234");
313313
XCTAssertEqual(loggedInSubscriptionStatus.emailAddress, @"[email protected]");
314314
XCTAssertEqual(loggedInSubscriptionStatus.emailAuthCode, @"test-hash-token");
315-
XCTAssertEqual(loggedInSubscriptionStatus.subscribed, true);
315+
XCTAssertEqual(loggedInSubscriptionStatus.isSubscribed, true);
316316

317317
[OneSignal logoutEmailWithSuccess:^{
318318
[expectation fulfill];
@@ -327,7 +327,7 @@ - (void)testSubscriptionState {
327327
XCTAssertNil(loggedOutSubscriptionStatus.emailAuthCode);
328328
XCTAssertNil(loggedOutSubscriptionStatus.emailAddress);
329329
XCTAssertNil(loggedOutSubscriptionStatus.emailUserId);
330-
XCTAssertFalse(loggedOutSubscriptionStatus.subscribed);
330+
XCTAssertFalse(loggedOutSubscriptionStatus.isSubscribed);
331331
}
332332

333333
- (void)testEmailSubscriptionObserver {

0 commit comments

Comments
 (0)