Notification Foreground Listener - API update

* Rename notificationWillShowInForegroundHandler to OSNotificationLifecycleListener
* It will have the `onWillDisplay` event.

Author: nan-li

iOS_SDK/OneSignalDevApp/OneSignalDevApp/AppDelegate.h

@@ -31,7 +31,7 @@
 #import <UIKit/UIKit.h>
 #import <OneSignalFramework/OneSignalFramework.h>
 
-@interface AppDelegate : UIResponder <UIApplicationDelegate, OSNotificationPermissionObserver, OSInAppMessageLifecycleListener, OSPushSubscriptionObserver>
+@interface AppDelegate : UIResponder <UIApplicationDelegate, OSNotificationPermissionObserver, OSInAppMessageLifecycleListener, OSPushSubscriptionObserver, OSNotificationLifecycleListener>
 
 @property (strong, nonatomic) UIWindow *window;
 

iOS_SDK/OneSignalDevApp/OneSignalDevApp/AppDelegate.m

@@ -66,10 +66,6 @@ - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(
         [alert show];
         #pragma clang diagnostic pop
     };
-    id notificationReceiverBlock = ^(OSNotification *notif, OSNotificationDisplayResponse completion) {
-        NSLog(@"Will Receive Notification - %@", notif.notificationId);
-        completion(notif);
-    };
 
     // Example block for IAM action click handler
     id inAppMessagingActionClickBlock = ^(OSInAppMessageAction *action) {
@@ -87,7 +83,7 @@ - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(
     [OneSignal.InAppMessages addLifecycleListener:self];
     [OneSignal.InAppMessages paused:true];
 
-    [OneSignal.Notifications setNotificationWillShowInForegroundHandler:notificationReceiverBlock];
+    [OneSignal.Notifications addForegroundLifecycleListener:self];
     [OneSignal.Notifications setNotificationOpenedHandler:openNotificationHandler];
 
     [OneSignal.User.pushSubscription addObserver:self];
@@ -134,6 +130,14 @@ - (void)handleMessageAction:(OSInAppMessageAction *)action {
     return;
 }
 
+- (void)onWillDisplayNotification:(OSNotificationWillDisplayEvent *)event {
+    NSLog(@"Dev App OSNotificationWillDisplayEvent with event: %@",event);
+    [event preventDefault];
+    dispatch_after(dispatch_time(DISPATCH_TIME_NOW, 5 * NSEC_PER_SEC), dispatch_get_main_queue(), ^{
+        [event.notification display];
+    });
+}
+
 - (void)onWillDisplayInAppMessage:(OSInAppMessageWillDisplayEvent *)event {
     NSLog(@"OSInAppMessageDelegate: onWillDisplay Message: %@",event.message);
     return;

iOS_SDK/OneSignalDevApp/OneSignalDevAppClip/AppDelegate.m

@@ -58,10 +58,6 @@ - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(
     id openNotificationHandler = ^(OSNotificationOpenedResult *result) {
         NSLog(@"OSNotificationOpenedResult: %@", result.action);
     };
-    id notificationReceiverBlock = ^(OSNotification *notif, OSNotificationDisplayResponse completion) {
-        NSLog(@"Will Receive Notification - %@", notif.notificationId);
-        completion(notif);
-    };
 
     // Example block for IAM action click handler
     id inAppMessagingActionClickBlock = ^(OSInAppMessageAction *action) {
@@ -87,7 +83,6 @@ - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(
 
     [OneSignal.InAppMessages paused:false];
 
-    [OneSignal.Notifications setNotificationWillShowInForegroundHandler:notificationReceiverBlock];
     [OneSignal.Notifications setNotificationOpenedHandler:openNotificationHandler];
 
     NSLog(@"UNUserNotificationCenter.delegate: %@", UNUserNotificationCenter.currentNotificationCenter.delegate);

iOS_SDK/OneSignalSDK/OneSignal.xcodeproj/project.pbxproj

@@ -466,7 +466,7 @@
 		DEF784642912FA5100A1F3A5 /* OSDialogInstanceManager.m in Sources */ = {isa = PBXBuildFile; fileRef = DEF784632912FA5100A1F3A5 /* OSDialogInstanceManager.m */; };
 		DEF784652912FB2200A1F3A5 /* OSDialogInstanceManager.h in Headers */ = {isa = PBXBuildFile; fileRef = DEF784622912F79700A1F3A5 /* OSDialogInstanceManager.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		DEF7846B2913176800A1F3A5 /* OneSignalNotifications.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = DEF784292912DEB600A1F3A5 /* OneSignalNotifications.framework */; };
-		DEF7847229132AA700A1F3A5 /* OSNotification+OneSignal.h in Headers */ = {isa = PBXBuildFile; fileRef = DEF7847029132AA700A1F3A5 /* OSNotification+OneSignal.h */; };
+		DEF7847229132AA700A1F3A5 /* OSNotification+OneSignal.h in Headers */ = {isa = PBXBuildFile; fileRef = DEF7847029132AA700A1F3A5 /* OSNotification+OneSignal.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		DEF7847329132AA700A1F3A5 /* OSNotification+OneSignal.m in Sources */ = {isa = PBXBuildFile; fileRef = DEF7847129132AA700A1F3A5 /* OSNotification+OneSignal.m */; };
 		DEF784792914667A00A1F3A5 /* NSDateFormatter+OneSignal.h in Headers */ = {isa = PBXBuildFile; fileRef = DE9877292591654600DE07D5 /* NSDateFormatter+OneSignal.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		DEF7847D29146B2700A1F3A5 /* OneSignalWebView.m in Sources */ = {isa = PBXBuildFile; fileRef = DEF7847B29146B2700A1F3A5 /* OneSignalWebView.m */; };

iOS_SDK/OneSignalSDK/OneSignalCore/Source/OSNotification+Internal.h

@@ -31,10 +31,6 @@
 #define OSNotification_Internal_h
 
 @interface OSNotification(Internal)
-+(instancetype _Nonnull )parseWithApns:(nonnull NSDictionary *)message;
-- (void)setCompletionBlock:(OSNotificationDisplayResponse _Nonnull)completion;
-- (void)startTimeoutTimer;
-- (void)complete:(nullable OSNotification *)notification;
 @end
 
 #endif /* OSNotification_Internal_h */

iOS_SDK/OneSignalSDK/OneSignalCore/Source/OSNotification.m

@@ -26,23 +26,12 @@
  */
 
 #import <Foundation/Foundation.h>
-
 #import <UIKit/UIKit.h>
-
 #import "OSNotification+Internal.h"
-
 #import "OSNotification.h"
-
-#import "OneSignalCommonDefines.h"
-
-#import "OneSignalUserDefaults.h"
-
 #import "OneSignalLog.h"
 
 @implementation OSNotification
-
- OSNotificationDisplayResponse _completion;
- NSTimer *_timeoutTimer;
 
 + (instancetype)parseWithApns:(nonnull NSDictionary*)message {
     if (!message)
@@ -63,8 +52,6 @@ - (void)initWithRawMessage:(NSDictionary*)message {
         [self parseOriginalPayload];
 
     [self parseOtherApnsFields];
-    
-    _timeoutTimer = [NSTimer timerWithTimeInterval:CUSTOM_DISPLAY_TYPE_TIMEOUT target:self selector:@selector(timeoutTimerFired:) userInfo:_notificationId repeats:false];
 }
 
 // Original OneSignal payload format.
@@ -300,34 +287,4 @@ - (NSString *)stringify {
     return [[NSString alloc] initWithData:jsonData encoding:NSUTF8StringEncoding];
 }
 
-#pragma mark willShowInForegroundHandler Methods
-
-- (void)setCompletionBlock:(OSNotificationDisplayResponse)completion {
-    _completion = completion;
-}
-
- - (void)complete:(OSNotification *)notification {
-     [_timeoutTimer invalidate];
-     if (_completion) {
-         _completion(notification);
-         _completion = nil;
-     }
- }
-
- - (void)startTimeoutTimer {
-     [[NSRunLoop currentRunLoop] addTimer:_timeoutTimer forMode:NSRunLoopCommonModes];
- }
-
- - (void)timeoutTimerFired:(NSTimer *)timer {
-     [OneSignalLog onesignalLog:ONE_S_LL_ERROR
-     message:[NSString stringWithFormat:@"Notification willShowInForeground completion timed out. Completion was not called within %f seconds.", CUSTOM_DISPLAY_TYPE_TIMEOUT]];
-     [self complete:self];
- }
-
- - (void)dealloc {
-     if (_timeoutTimer && _completion) {
-         [_timeoutTimer invalidate];
-     }
- }
-
 @end

iOS_SDK/OneSignalSDK/OneSignalNotifications/OSNotification+OneSignal.h

@@ -27,8 +27,11 @@
 
 
 #import <Foundation/Foundation.h>
-#import <OneSignalCore/OneSignalCore.h>
+#import <OneSignalCore/OSNotification.h>
 
-@interface OSNotification (OneSignal)
-- (OSNotificationDisplayResponse _Nullable)getCompletionBlock;
+/**
+ Public interface used in the OSNotificationLifecycleListener's onWillDisplay event.
+ */
+@interface OSDisplayableNotification : OSNotification
+- (void)display;
 @end

iOS_SDK/OneSignalSDK/OneSignalNotifications/OSNotification+OneSignal.m

@@ -25,22 +25,82 @@
  * THE SOFTWARE.
  */
 
-
 #import "OSNotification+OneSignal.h"
+#import <OneSignalCore/OneSignalCore.h>
 #import <UIKit/UIKit.h>
-@implementation OSNotification (OneSignal)
- - (OSNotificationDisplayResponse)getCompletionBlock {
-     OSNotificationDisplayResponse block = ^(OSNotification *notification){
-         /*
-          If notification is null here then display was cancelled and we need to
-          reset the badge count to the value prior to receipt of this notif
-          */
-         if (!notification) {
-             NSInteger previousBadgeCount = [UIApplication sharedApplication].applicationIconBadgeNumber;
-             [OneSignalUserDefaults.initShared saveIntegerForKey:ONESIGNAL_BADGE_KEY withValue:previousBadgeCount];
-         }
-         [self complete:notification];
-     };
-     return block;
- }
+
+@interface OSNotification ()
+- (void)initWithRawMessage:(NSDictionary*)message;
+@end
+
+@implementation OSDisplayableNotification
+
+OSNotificationDisplayResponse _completion;
+NSTimer *_timeoutTimer;
+BOOL _wantsToDisplay = true;
+
++ (instancetype)parseWithApns:(nonnull NSDictionary*)message {
+    if (!message)
+        return nil;
+    
+    OSDisplayableNotification *osNotification = [OSDisplayableNotification new];
+    
+    [osNotification initWithRawMessage:message];
+    [osNotification setTimeoutTimer];
+    return osNotification;
+}
+
+- (void)setTimeoutTimer {
+    _timeoutTimer = [NSTimer timerWithTimeInterval:CUSTOM_DISPLAY_TYPE_TIMEOUT target:self selector:@selector(timeoutTimerFired:) userInfo:self.notificationId repeats:false];
+}
+
+- (void)startTimeoutTimer {
+    [[NSRunLoop currentRunLoop] addTimer:_timeoutTimer forMode:NSRunLoopCommonModes];
+}
+
+- (void)setCompletionBlock:(OSNotificationDisplayResponse)completion {
+    _completion = completion;
+}
+
+- (void)display {
+    if (!_completion) {
+        [OneSignalLog onesignalLog:ONE_S_LL_ERROR message:@"OSNotificationWillDisplayEvent.notification.display cannot be called due to timing out or notification was already displayed."];
+    }
+    [self complete:self];
+}
+
+- (void)complete:(OSDisplayableNotification *)notification {
+    [_timeoutTimer invalidate];
+    /*
+     If notification is null here then display was cancelled and we need to
+     reset the badge count to the value prior to receipt of this notif
+     */
+    if (!notification) {
+        NSInteger previousBadgeCount = [UIApplication sharedApplication].applicationIconBadgeNumber;
+        [OneSignalUserDefaults.initShared saveIntegerForKey:ONESIGNAL_BADGE_KEY withValue:previousBadgeCount];
+    }
+    if (_completion) {
+        _completion(notification);
+        _completion = nil;
+    }
+}
+
+- (void)setWantsToDisplay:(BOOL)display {
+    _wantsToDisplay = display;
+}
+
+- (void)timeoutTimerFired:(NSTimer *)timer {
+    [OneSignalLog onesignalLog:ONE_S_LL_WARN message:[NSString stringWithFormat:@"OSNotificationLifecycleListener:onWillDisplayNotification timed out. Display was not called within %f seconds. Continue with display notification: %d", CUSTOM_DISPLAY_TYPE_TIMEOUT, _wantsToDisplay]];
+    if (_wantsToDisplay) {
+        [self complete:self];
+    } else {
+        [self complete:nil];
+    }
+}
+
+- (void)dealloc {
+    if (_timeoutTimer && _completion) {
+        [_timeoutTimer invalidate];
+    }
+}
 @end

iOS_SDK/OneSignalSDK/OneSignalNotifications/OSNotificationsManager.h

@@ -30,19 +30,31 @@
 #import <OneSignalNotifications/OSPermission.h>
 #import <OneSignalCore/OneSignalCore.h>
 #import <UIKit/UIKit.h>
+#import <OneSignalNotifications/OSNotification+OneSignal.h>
 
-// If the completion block is not called within 25 seconds of this block being called in notificationWillShowInForegroundHandler then the completion will be automatically fired.
-typedef void (^OSNotificationWillShowInForegroundBlock)(OSNotification * _Nonnull notification, OSNotificationDisplayResponse _Nonnull completion);
 typedef void (^OSNotificationOpenedBlock)(OSNotificationOpenedResult * _Nonnull result);
 
+@interface OSNotificationWillDisplayEvent : NSObject
+
+@property (readonly, strong, nonatomic, nonnull) OSDisplayableNotification *notification; // TODO: strong? nonatomic? nullable?
+- (void)preventDefault;
+
+@end
+
+@protocol OSNotificationLifecycleListener <NSObject>
+- (void)onWillDisplayNotification:(OSNotificationWillDisplayEvent *_Nonnull)event NS_SWIFT_NAME(onWillDisplay(event:));
+@end
+
 /**
  Public API for the Notifications namespace.
  */
 @protocol OSNotifications <NSObject>
 + (BOOL)permission NS_REFINED_FOR_SWIFT;
 + (BOOL)canRequestPermission NS_REFINED_FOR_SWIFT;
 + (OSNotificationPermission)permissionNative NS_REFINED_FOR_SWIFT;
-+ (void)setNotificationWillShowInForegroundHandler:(OSNotificationWillShowInForegroundBlock _Nullable)block;
++ (void)addForegroundLifecycleListener:(NSObject<OSNotificationLifecycleListener> *_Nullable)listener;
++ (void)removeForegroundLifecycleListener:(NSObject<OSNotificationLifecycleListener> *_Nullable)listener;
+
 + (void)setNotificationOpenedHandler:(OSNotificationOpenedBlock _Nullable)block;
 + (void)requestPermission:(OSUserResponseBlock _Nullable )block;
 + (void)requestPermission:(OSUserResponseBlock _Nullable )block fallbackToSettings:(BOOL)fallback;
@@ -65,6 +77,7 @@ typedef void (^OSNotificationOpenedBlock)(OSNotificationOpenedResult * _Nonnull
 @interface OSNotificationsManager : NSObject <OSNotifications>
 
 @property (class, weak, nonatomic, nullable) id<OneSignalNotificationsDelegate> delegate;
+@property (class, weak, nonatomic, nullable) NSObject<OSNotificationLifecycleListener> *lifecycleListener;
 
 + (Class<OSNotifications> _Nonnull)Notifications;
 + (void)start;
@@ -97,7 +110,7 @@ typedef void (^OSNotificationOpenedBlock)(OSNotificationOpenedResult * _Nonnull
 // This is set by the user module
 + (void)setPushSubscriptionId:(NSString *_Nullable)pushSubscriptionId;
 
-+ (void)handleWillShowInForegroundHandlerForNotification:(OSNotification *_Nonnull)notification completion:(OSNotificationDisplayResponse _Nonnull)completion;
++ (void)handleWillShowInForegroundForNotification:(OSNotification *_Nonnull)notification completion:(OSNotificationDisplayResponse _Nonnull)completion;
 + (void)handleNotificationAction:(OSNotificationActionType)actionType actionID:(NSString* _Nonnull)actionID;
 
 + (BOOL)clearBadgeCount:(BOOL)fromNotifOpened;