Adding ephemeral permission state

Author: emawby

iOS_SDK/OneSignalSDK/Source/OSPermission.h

@@ -50,6 +50,7 @@ typedef OSObservable<NSObject<OSPermissionStateObserver>*, OSPermissionState*> O
 @property (readwrite, nonatomic) BOOL answeredPrompt;
 @property (readwrite, nonatomic) BOOL accepted;
 @property (readwrite, nonatomic) BOOL provisional; //internal flag
+@property (readwrite, nonatomic) BOOL ephemeral;
 @property (readwrite, nonatomic) BOOL reachable;
 @property int notificationTypes;
 

iOS_SDK/OneSignalSDK/Source/OSPermission.m

@@ -49,6 +49,7 @@ - (instancetype)initAsFrom {
     _hasPrompted = [standardUserDefaults getSavedBoolForKey:OSUD_WAS_PROMPTED_FOR_NOTIFICATIONS_FROM defaultValue:false];
     _answeredPrompt = [standardUserDefaults getSavedBoolForKey:OSUD_WAS_NOTIFICATION_PROMPT_ANSWERED_FROM defaultValue:false];
     _accepted  = [standardUserDefaults getSavedBoolForKey:OSUD_PERMISSION_ACCEPTED_FROM defaultValue:false];
+    _ephemeral = [standardUserDefaults getSavedBoolForKey:OSUD_PERMISSION_EPHEMERAL_FROM defaultValue:false];
     _provisional = [standardUserDefaults getSavedBoolForKey:OSUD_PROVISIONAL_PUSH_AUTHORIZATION_FROM defaultValue:false];
     _providesAppNotificationSettings = [standardUserDefaults getSavedBoolForKey:OSUD_APP_PROVIDES_NOTIFICATION_SETTINGS defaultValue:false];
 
@@ -60,6 +61,7 @@ - (void)persistAsFrom {
     [standardUserDefaults saveBoolForKey:OSUD_WAS_PROMPTED_FOR_NOTIFICATIONS_FROM withValue:_hasPrompted];
     [standardUserDefaults saveBoolForKey:OSUD_WAS_NOTIFICATION_PROMPT_ANSWERED_FROM withValue:_answeredPrompt];
     [standardUserDefaults saveBoolForKey:OSUD_PERMISSION_ACCEPTED_FROM withValue:_accepted];
+    [standardUserDefaults saveBoolForKey:OSUD_PERMISSION_EPHEMERAL_FROM withValue:_ephemeral];
     [standardUserDefaults saveBoolForKey:OSUD_PROVISIONAL_PUSH_AUTHORIZATION_FROM withValue:_provisional];
     [standardUserDefaults saveBoolForKey:OSUD_APP_PROVIDES_NOTIFICATION_SETTINGS withValue:_providesAppNotificationSettings];
 }
@@ -72,6 +74,7 @@ - (instancetype)copyWithZone:(NSZone*)zone {
         copy->_hasPrompted = _hasPrompted;
         copy->_answeredPrompt = _answeredPrompt;
         copy->_accepted = _accepted;
+        copy->_ephemeral = _ephemeral;
         copy->_provisional = _provisional;
         copy->_providesAppNotificationSettings = _providesAppNotificationSettings;
     }
@@ -94,7 +97,7 @@ - (BOOL)hasPrompted {
 }
 
 - (BOOL)reachable {
-    return self.provisional || self.accepted;
+    return self.provisional || self.accepted || self.ephemeral;
 }
 
 - (void)setProvisional:(BOOL)provisional {
@@ -130,6 +133,13 @@ - (void)setAccepted:(BOOL)accepted {
         [self.observable notifyChange:self];
 }
 
+- (void)setEphemeral:(BOOL)ephemeral {
+    BOOL changed = _ephemeral != ephemeral;
+    _ephemeral = ephemeral;
+    if (changed)
+        [self.observable notifyChange:self];
+}
+
 - (void)setProvidesAppNotificationSettings:(BOOL)providesAppNotificationSettings {
     _providesAppNotificationSettings = providesAppNotificationSettings;
 }
@@ -141,6 +151,9 @@ - (OSNotificationPermission)status {
     if (self.answeredPrompt)
         return OSNotificationPermissionDenied;
 
+    if (self.ephemeral)
+        return OSNotificationPermissionEphemeral;
+    
     if (self.provisional)
         return OSNotificationPermissionProvisional;
 
@@ -157,12 +170,15 @@ - (NSString*)statusAsString {
             return @"Denied";
         case OSNotificationPermissionProvisional:
             return @"Provisional";
+        case OSNotificationPermissionEphemeral:
+            return @"Ephemeral";
     }
     return @"NotDetermined";
 }
 
 - (BOOL)compare:(OSPermissionState*)from {
     return self.accepted != from.accepted ||
+           self.ephemeral != from.ephemeral ||
            self.answeredPrompt != from.answeredPrompt ||
            self.hasPrompted != from.hasPrompted;
 }

iOS_SDK/OneSignalSDK/Source/OneSignal.h

@@ -253,6 +253,9 @@ typedef NS_ENUM(NSInteger, OSNotificationPermission) {
 
     // the application is only authorized to post Provisional notifications (direct to history)
     OSNotificationPermissionProvisional
+    
+    // the application is authorized to send notifications for 8 hours. Only used by App Clips.
+    OSNotificationPermissionEphemeral
 };
 
 // Permission Classes

iOS_SDK/OneSignalSDK/Source/OneSignalCommonDefines.h

@@ -59,6 +59,8 @@
 #define OSUD_PROVISIONAL_PUSH_AUTHORIZATION_TO                              @"OSUD_PROVISIONAL_PUSH_AUTHORIZATION_TO"                           // OSUD_PROVISIONAL_PUSH_AUTHORIZATION_TO
 #define OSUD_PROVISIONAL_PUSH_AUTHORIZATION_FROM                            @"ONESIGNAL_PROVISIONAL_AUTHORIZATION_LAST"                         // * OSUD_PROVISIONAL_PUSH_AUTHORIZATION_FROM
 #define OSUD_USES_PROVISIONAL_PUSH_AUTHORIZATION                            @"ONESIGNAL_USES_PROVISIONAL_PUSH_AUTHORIZATION"                    // * OSUD_USES_PROVISIONAL_PUSH_AUTHORIZATION
+#define OSUD_PERMISSION_EPHEMERAL_TO                                        @"OSUD_PERMISSION_EPHEMERAL_TO"                                     // * OSUD_PERMISSION_EPHEMERAL_TO
+#define OSUD_PERMISSION_EPHEMERAL_FROM                                      @"OSUD_PERMISSION_EPHEMERAL_FROM"                                   // * OSUD_PERMISSION_EPHEMERAL_FROM
 // Player
 #define OSUD_EXTERNAL_USER_ID                                               @"OS_EXTERNAL_USER_ID"                                              // * OSUD_EXTERNAL_USER_ID
 #define OSUD_PLAYER_ID_TO                                                   @"GT_PLAYER_ID"                                                     // * OSUD_PLAYER_ID_TO