Merge pull request #1223 from OneSignal/5.0.0/beta_01_update_api

[5.0.0] Update API for beta-01

Author: nan-li

MIGRATION_GUIDE.md

@@ -51,7 +51,7 @@ - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(
 
     NSLog(@"Bundle URL: %@", [[NSBundle mainBundle] bundleURL]);
     [OneSignal.Debug setLogLevel:ONE_S_LL_VERBOSE];
-    [OneSignal.Debug setVisualLevel:ONE_S_LL_NONE];
+    [OneSignal.Debug setAlertLevel:ONE_S_LL_NONE];
 
     [OneSignal initialize:[AppDelegate getOneSignalAppId] withLaunchOptions:launchOptions];
 
@@ -90,8 +90,8 @@ - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(
     [OneSignal.Notifications setNotificationWillShowInForegroundHandler:notificationReceiverBlock];
     [OneSignal.Notifications setNotificationOpenedHandler:openNotificationHandler];
 
-    OSPushSubscriptionState* state = [OneSignal.User.pushSubscription addObserver:self];
-    NSLog(@"OneSignal Demo App push subscription observer added, current state: %@", state);
+    [OneSignal.User.pushSubscription addObserver:self];
+    NSLog(@"OneSignal Demo App push subscription observer added");
 
     [OneSignal.Notifications addPermissionObserver:self];
 
@@ -117,12 +117,12 @@ + (void) setOneSignalAppId:(NSString*)onesignalAppId {
     // [OneSignal setAppId:onesignalAppId];
 }
 
-- (void) onOSPermissionChanged:(OSPermissionStateChanges*)stateChanges {
-    NSLog(@"onOSPermissionChanged: %@", stateChanges);
+- (void)onOSPermissionChanged:(OSPermissionState*)state {
+    NSLog(@"Dev App onOSPermissionChanged: %@", state);
 }
 
 - (void)onOSPushSubscriptionChangedWithStateChanges:(OSPushSubscriptionStateChanges *)stateChanges {
-    NSLog(@"onOSPushSubscriptionChangedWithStateChanges: %@", stateChanges);
+    NSLog(@"Dev App onOSPushSubscriptionChangedWithStateChanges: %@", stateChanges);
     ViewController* mainController = (ViewController*) self.window.rootViewController;
     mainController.subscriptionSegmentedControl.selectedSegmentIndex = (NSInteger) stateChanges.to.optedIn;
 }

iOS_SDK/OneSignalDevApp/OneSignalDevApp/AppDelegate.m

@@ -100,13 +100,13 @@ - (IBAction)removeEmailButton:(id)sender {
 - (IBAction)addSmsButton:(id)sender {
     NSString *sms = self.smsTextField.text;
     NSLog(@"Dev App: Add sms: %@", sms);
-    [OneSignal.User addSmsNumber:sms];
+    [OneSignal.User addSms:sms];
 }
 
 - (IBAction)removeSmsButton:(id)sender {
     NSString *sms = self.smsTextField.text;
     NSLog(@"Dev App: Removing sms: %@", sms);
-    [OneSignal.User removeSmsNumber:sms];
+    [OneSignal.User removeSms:sms];
 }
 
 - (IBAction)addAliasButton:(UIButton *)sender {
@@ -131,13 +131,7 @@ - (IBAction)sendTagButton:(id)sender {
 }
 
 - (IBAction)getInfoButton:(id)sender {
-    NSLog(@"💛 Dev App: get User and Device information");
-    [OneSignalUserManagerImpl.sharedInstance internalDumpInfo];
-    NSLog(@"💛 Dev App: OneSignal.Notifications permission: %d", [OneSignal.Notifications permission]);
-    NSLog(@"💛 Dev App: OneSignal.Notifications.canRequestPermission: %d", [OneSignal.Notifications canRequestPermission]);
-    [OneSignal internalDumpInfo];
-    NSLog(@"💛 Dev App: getPrivacyConsent: %d", OneSignal.getPrivacyConsent);
-    NSLog(@"💛 Dev App: requiresPrivacyConsent: %d", [OneSignal requiresPrivacyConsent]);
+    NSLog(@"Dev App: get User and Device information, you need to fill in");
 }
 
 - (IBAction)sendTagsButton:(id)sender {

iOS_SDK/OneSignalDevApp/OneSignalDevApp/ViewController.m

@@ -52,7 +52,7 @@ - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(
     NSLog(@"Bundle URL: %@", [[NSBundle mainBundle] bundleURL]);
 
     [OneSignal.Debug setLogLevel:ONE_S_LL_VERBOSE];
-    [OneSignal.Debug setVisualLevel:ONE_S_LL_NONE];
+    [OneSignal.Debug setAlertLevel:ONE_S_LL_NONE];
     _notificationDelegate = [OneSignalNotificationCenterDelegate new];
 
     id openNotificationHandler = ^(OSNotificationOpenedResult *result) {
@@ -112,8 +112,8 @@ + (void) setOneSignalAppId:(NSString*)onesignalAppId {
     [OneSignal initialize:onesignalAppId withLaunchOptions:nil];
 }
 
-- (void) onOSPermissionChanged:(OSPermissionStateChanges*)stateChanges {
-    NSLog(@"onOSPermissionChanged: %@", stateChanges);
+- (void) onOSPermissionChanged:(OSPermissionState*)state {
+    NSLog(@"onOSPermissionChanged: %@", state);
 }
 
 // TODO: Add push sub observer

iOS_SDK/OneSignalDevApp/OneSignalDevAppClip/AppDelegate.m

@@ -38,12 +38,12 @@ typedef NS_ENUM(NSUInteger, ONE_S_LOG_LEVEL) {
 
 @protocol OSDebug <NSObject>
 + (void)setLogLevel:(ONE_S_LOG_LEVEL)logLevel;
-+ (void)setVisualLevel:(ONE_S_LOG_LEVEL)visualLogLevel;
++ (void)setAlertLevel:(ONE_S_LOG_LEVEL)logLevel NS_REFINED_FOR_SWIFT;
 @end
 
 @interface OneSignalLog : NSObject<OSDebug>
 + (Class<OSDebug>)Debug;
 + (void)setLogLevel:(ONE_S_LOG_LEVEL)logLevel;
-+ (void)setVisualLevel:(ONE_S_LOG_LEVEL)visualLogLevel;
++ (void)setAlertLevel:(ONE_S_LOG_LEVEL)logLevel;
 + (void)onesignalLog:(ONE_S_LOG_LEVEL)logLevel message:(NSString* _Nonnull)message;
 @end

iOS_SDK/OneSignalSDK/OneSignalCore/Source/OneSignalLog.h

@@ -32,7 +32,7 @@
 @implementation OneSignalLog
 
 static ONE_S_LOG_LEVEL _nsLogLevel = ONE_S_LL_WARN;
-static ONE_S_LOG_LEVEL _visualLogLevel = ONE_S_LL_NONE;
+static ONE_S_LOG_LEVEL _alertLogLevel = ONE_S_LL_NONE;
 
 + (Class<OSDebug>)Debug {
     return self;
@@ -42,8 +42,8 @@ + (void)setLogLevel:(ONE_S_LOG_LEVEL)nsLogLevel {
     _nsLogLevel = nsLogLevel;
 }
 
-+ (void)setVisualLevel:(ONE_S_LOG_LEVEL)visualLogLevel {
-    _visualLogLevel = visualLogLevel;
++ (void)setAlertLevel:(ONE_S_LOG_LEVEL)logLevel {
+    _alertLogLevel = logLevel;
 }
 
 + (void)onesignalLog:(ONE_S_LOG_LEVEL)logLevel message:(NSString* _Nonnull)message {
@@ -79,7 +79,7 @@ void onesignal_Log(ONE_S_LOG_LEVEL logLevel, NSString* message) {
     if (logLevel <= _nsLogLevel)
         NSLog(@"%@", [levelString stringByAppendingString:message]);
 
-    if (logLevel <= _visualLogLevel) {
+    if (logLevel <= _alertLogLevel) {
         [[OSDialogInstanceManager sharedInstance] presentDialogWithTitle:levelString withMessage:message withActions:nil cancelTitle:NSLocalizedString(@"Close", @"Close button") withActionCompletion:nil];
     }
 }

iOS_SDK/OneSignalSDK/OneSignalCore/Source/OneSignalLog.m

@@ -35,6 +35,8 @@ @implementation OSRemoteParamController
 
 static OSRemoteParamController *_sharedController;
 + (OSRemoteParamController *)sharedController {
+    if (!_sharedController)
+        _sharedController = [OSRemoteParamController new];
     return _sharedController;
 }
 

iOS_SDK/OneSignalSDK/OneSignalCore/Source/RemoteParameters/OSRemoteParamController.m

@@ -57,7 +57,7 @@ typedef void (^OSNotificationOpenedBlock)(OSNotificationOpenedResult * _Nonnull
 // can check responds to selector
 - (void)setNotificationTypes:(int)notificationTypes;
 - (void)setPushToken:(NSString * _Nonnull)pushToken;
-- (void)setAccepted:(BOOL)inAccepted;
+- (void)setReachable:(BOOL)inReachable;
 
 @end
 

iOS_SDK/OneSignalSDK/OneSignalNotifications/OSNotificationsManager.h

@@ -143,6 +143,7 @@ + (OneSignalNotificationSettings *)osNotificationSettings {
     return _osNotificationSettings;
 }
 
+// static property def to add developer's OSPermissionStateChanges observers to.
 static ObservablePermissionStateChangesType* _permissionStateChangesObserver;
 + (ObservablePermissionStateChangesType*)permissionStateChangesObserver {
     if (!_permissionStateChangesObserver)
@@ -336,6 +337,8 @@ + (void)presentAppSettings {
 }
 
 + (void)clearAll {
+    [[UNUserNotificationCenter currentNotificationCenter] removeAllDeliveredNotifications];
+    // TODO: Determine if we also need to call clearBadgeCount
     [self clearBadgeCount:false];
 }
 
@@ -368,9 +371,6 @@ + (BOOL)registerForAPNsToken {
 
 + (void)didRegisterForRemoteNotifications:(UIApplication *)app
                               deviceToken:(NSData *)inDeviceToken {
-    if ([OSPrivacyConsentController shouldLogMissingPrivacyConsentErrorWithMethodName:nil])
-        return;
-
     let parsedDeviceToken = [NSString hexStringFromData:inDeviceToken];
 
     [OneSignalLog onesignalLog:ONE_S_LL_INFO message: [NSString stringWithFormat:@"Device Registered with Apple: %@", parsedDeviceToken]];
@@ -421,11 +421,11 @@ + (void)setSubscriptionErrorStatus:(int)errorType {
     [self sendNotificationTypesUpdateToDelegate];
 }
 
-// onOSPermissionChanged should only fire if something changed.
+// onOSPermissionChanged should only fire if the reachable property changed.
 + (void)addPermissionObserver:(NSObject<OSPermissionObserver>*)observer {
     [self.permissionStateChangesObserver addObserver:observer];
 
-    if ([self.currentPermissionState compare:self.lastPermissionState])
+    if (self.currentPermissionState.reachable != self.lastPermissionState.reachable)
         [OSPermissionChangedInternalObserver fireChangesObserver:self.currentPermissionState];
 }
 
@@ -455,8 +455,8 @@ + (void)updateNotificationTypes:(int)notificationTypes {
 + (void)sendNotificationTypesUpdateToDelegate {
     // We don't delay observer update to wait until the OneSignal server is notified
     // TODO: We can do the above and delay observers until server is updated.
-    if (self.delegate && [self.delegate respondsToSelector:@selector(setAccepted:)]) {
-        [self.delegate setAccepted:[self getNotificationTypes] > 0];
+    if (self.delegate && [self.delegate respondsToSelector:@selector(setReachable:)]) {
+        [self.delegate setReachable:[self getNotificationTypes] > 0];
     }
     if (self.delegate && [self.delegate respondsToSelector:@selector(setNotificationTypes:)]) {
         [self.delegate setNotificationTypes:[self getNotificationTypes]];

iOS_SDK/OneSignalSDK/OneSignalNotifications/OSNotificationsManager.m

@@ -49,13 +49,9 @@ typedef NS_ENUM(NSInteger, OSNotificationPermission) {
 // Permission Classes
 @interface OSPermissionState : NSObject
 // TODO: Decide: remove/change properties after addition of canRequestPermission and permission boolean
-@property (readonly, nonatomic) BOOL reachable;
-@property (readonly, nonatomic) BOOL hasPrompted;
-@property (readonly, nonatomic) BOOL provisional;
-@property (readonly, nonatomic) BOOL providesAppNotificationSettings;
-@property (readonly, nonatomic) OSNotificationPermission status;
+@property (readonly, nonatomic) BOOL permission;
 - (NSDictionary * _Nonnull)jsonRepresentation;
-- (instancetype _Nonnull )initWithStatus:(OSNotificationPermission)status reachable:(BOOL)reachable hasPrompted:(BOOL)hasPrompted provisional:(BOOL)provisional providesAppNotificationSettings:(BOOL)providesAppNotificationSettings;
+- (instancetype _Nonnull )initWithPermission:(BOOL)permission;
 @end
 
 @protocol OSPermissionStateObserver<NSObject>
@@ -87,24 +83,15 @@ typedef OSObservable<NSObject<OSPermissionStateObserver>*, OSPermissionState*> O
 - (instancetype _Nonnull )initAsTo;
 - (instancetype _Nonnull )initAsFrom;
 
-- (BOOL)compare:(OSPermissionStateInternal * _Nonnull)from;
 - (OSPermissionState * _Nonnull)getExternalState;
-
-@end
-
-@interface OSPermissionStateChanges : NSObject
-
-@property (readonly, nonnull) OSPermissionState* to;
-@property (readonly, nonnull) OSPermissionState* from;
 - (NSDictionary * _Nonnull)jsonRepresentation;
-- (instancetype _Nonnull)initAsTo:(OSPermissionState * _Nonnull)to from:(OSPermissionState * _Nonnull)from;
 @end
 
 @protocol OSPermissionObserver <NSObject>
-- (void)onOSPermissionChanged:(OSPermissionStateChanges * _Nonnull)stateChanges;
+- (void)onOSPermissionChanged:(OSPermissionState * _Nonnull)state;
 @end
 
-typedef OSObservable<NSObject<OSPermissionObserver>*, OSPermissionStateChanges*> ObservablePermissionStateChangesType;
+typedef OSObservable<NSObject<OSPermissionObserver>*, OSPermissionState*> ObservablePermissionStateChangesType;
 
 
 @interface OSPermissionChangedInternalObserver : NSObject<OSPermissionStateObserver>