IAM Lifecycle Listener - API update

* Rename `OSInAppMessageLifecycleHandler` to `OSInAppMessageLifecycleListener`
* The methods will receive specific event types such as `OSInAppMessageDidDisplayEvent` instead of just the `OSInAppMessage`
* Add a remove method `removeLifecycleListener`
* Due to Obj-C not allowing method overloading, add `InAppMessage` to method names, so it doesn't conflict with Notifications displays, but this doesn't apply to Swift as we can refine the swift name.
- onWillDisplayInAppMessage
- onDidDisplayInAppMessage
- onWillDismissInAppMessage
- onDidDismissInAppMessage

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, OSInAppMessageLifecycleHandler, OSPushSubscriptionObserver>
+@interface AppDelegate : UIResponder <UIApplicationDelegate, OSNotificationPermissionObserver, OSInAppMessageLifecycleListener, OSPushSubscriptionObserver>
 
 @property (strong, nonatomic) UIWindow *window;
 

iOS_SDK/OneSignalDevApp/OneSignalDevApp/AppDelegate.m

@@ -84,7 +84,7 @@ - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(
     [OneSignal setLaunchURLsInApp:YES];
     [OneSignal setProvidesNotificationSettingsView:NO];
 
-    [OneSignal.InAppMessages setLifecycleHandler:self];
+    [OneSignal.InAppMessages addLifecycleListener:self];
     [OneSignal.InAppMessages paused:true];
 
     [OneSignal.Notifications setNotificationWillShowInForegroundHandler:notificationReceiverBlock];
@@ -134,23 +134,23 @@ - (void)handleMessageAction:(OSInAppMessageAction *)action {
     return;
 }
 
-- (void)onWillDisplayInAppMessage:(OSInAppMessage *)message {
-    NSLog(@"OSInAppMessageDelegate: onWillDisplay Message: %@",message);
+- (void)onWillDisplayInAppMessage:(OSInAppMessageWillDisplayEvent *)event {
+    NSLog(@"OSInAppMessageDelegate: onWillDisplay Message: %@",event.message);
     return;
 }
 
-- (void)onDidDisplayInAppMessage:(OSInAppMessage *)message {
-    NSLog(@"OSInAppMessageDelegate: onDidDisplay Message: %@",message);
+- (void)onDidDisplayInAppMessage:(OSInAppMessageDidDisplayEvent *)event {
+    NSLog(@"OSInAppMessageDelegate: onDidDisplay Message: %@",event.message);
     return;
 }
 
-- (void)onWillDismissInAppMessage:(OSInAppMessage *)message {
-    NSLog(@"OSInAppMessageDelegate: onWillDismiss Message: %@",message);
+- (void)onWillDismissInAppMessage:(OSInAppMessageWillDismissEvent *)event {
+    NSLog(@"OSInAppMessageDelegate: onWillDismiss Message: %@",event.message);
     return;
 }
 
-- (void)onDidDismissInAppMessage:(OSInAppMessage *)message {
-    NSLog(@"OSInAppMessageDelegate: onDidDismiss Message: %@",message);
+- (void)onDidDismissInAppMessage:(OSInAppMessageDidDismissEvent *)event {
+    NSLog(@"OSInAppMessageDelegate: onDidDismiss Message: %@",event.message);
     return;
 }
 

iOS_SDK/OneSignalSDK/Source/OSMessagingController.h

@@ -65,7 +65,8 @@ NS_ASSUME_NONNULL_BEGIN
 - (id)getTriggerValueForKey:(NSString *)key;
 
 - (void)setInAppMessageClickHandler:(OSInAppMessageClickBlock)actionClickBlock;
-- (void)setInAppMessageDelegate:(NSObject<OSInAppMessageLifecycleHandler> *_Nullable)delegate;
+- (void)setInAppMessageDelegate:(NSObject<OSInAppMessageLifecycleListener> *_Nullable)delegate;
+- (void)removeInAppMessageDelegate:(NSObject<OSInAppMessageLifecycleListener> *_Nullable)delegate;
 
 @end
 

iOS_SDK/OneSignalSDK/Source/OSMessagingController.m

@@ -42,6 +42,34 @@ + (void)sendClickActionOutcomes:(NSArray<OSInAppMessageOutcome *> *)outcomes;
 
 @end
 
+@implementation OSInAppMessageWillDisplayEvent
+- (OSInAppMessageWillDisplayEvent*)initWithInAppMessage:(OSInAppMessage *)message {
+    _message = message;
+    return self;
+}
+@end
+
+@implementation OSInAppMessageDidDisplayEvent
+- (OSInAppMessageDidDisplayEvent*)initWithInAppMessage:(OSInAppMessage *)message {
+    _message = message;
+    return self;
+}
+@end
+
+@implementation OSInAppMessageWillDismissEvent
+- (OSInAppMessageWillDismissEvent*)initWithInAppMessage:(OSInAppMessage *)message {
+    _message = message;
+    return self;
+}
+@end
+
+@implementation OSInAppMessageDidDismissEvent
+- (OSInAppMessageDidDismissEvent*)initWithInAppMessage:(OSInAppMessage *)message {
+    _message = message;
+    return self;
+}
+@end
+
 @interface OSMessagingController ()
 
 @property (strong, nonatomic, nullable) UIWindow *window;
@@ -68,7 +96,7 @@ @interface OSMessagingController ()
 // Click action block to allow overridden behavior when clicking an IAM
 @property (strong, nonatomic, nullable) OSInAppMessageClickBlock actionClickBlock;
 
-@property (weak, nonatomic, nullable) NSObject<OSInAppMessageLifecycleHandler> *inAppMessageDelegate;
+@property (weak, nonatomic, nullable) NSObject<OSInAppMessageLifecycleListener> *inAppMessageDelegate;
 
 @property (strong, nullable) OSInAppMessageViewController *viewController;
 
@@ -281,35 +309,43 @@ - (void)setInAppMessageClickHandler:(OSInAppMessageClickBlock)actionClickBlock {
     self.actionClickBlock = actionClickBlock;
 }
 
-- (void)setInAppMessageDelegate:(NSObject<OSInAppMessageLifecycleHandler> *_Nullable)delegate {
+- (void)setInAppMessageDelegate:(NSObject<OSInAppMessageLifecycleListener> *_Nullable)delegate {
     _inAppMessageDelegate = delegate;
 }
 
+- (void)removeInAppMessageDelegate:(NSObject<OSInAppMessageLifecycleListener> *_Nullable)delegate {
+    _inAppMessageDelegate = nil;
+}
+
 - (void)onWillDisplayInAppMessage:(OSInAppMessageInternal *)message {
     if (self.inAppMessageDelegate &&
         [self.inAppMessageDelegate respondsToSelector:@selector(onWillDisplayInAppMessage:)]) {
-        [self.inAppMessageDelegate onWillDisplayInAppMessage:message];
+        OSInAppMessageWillDisplayEvent *event = [[OSInAppMessageWillDisplayEvent alloc] initWithInAppMessage:message];
+        [self.inAppMessageDelegate onWillDisplayInAppMessage:event];
     }
 }
 
 - (void)onDidDisplayInAppMessage:(OSInAppMessageInternal *)message {
     if (self.inAppMessageDelegate &&
         [self.inAppMessageDelegate respondsToSelector:@selector(onDidDisplayInAppMessage:)]) {
-        [self.inAppMessageDelegate onDidDisplayInAppMessage:message];
+        OSInAppMessageDidDisplayEvent *event = [[OSInAppMessageDidDisplayEvent alloc] initWithInAppMessage:message];
+        [self.inAppMessageDelegate onDidDisplayInAppMessage:event];
     }
 }
 
 - (void)onWillDismissInAppMessage:(OSInAppMessageInternal *)message {
     if (self.inAppMessageDelegate &&
         [self.inAppMessageDelegate respondsToSelector:@selector(onWillDismissInAppMessage:)]) {
-        [self.inAppMessageDelegate onWillDismissInAppMessage:message];
+        OSInAppMessageWillDismissEvent *event = [[OSInAppMessageWillDismissEvent alloc] initWithInAppMessage:message];
+        [self.inAppMessageDelegate onWillDismissInAppMessage:event];
     }
 }
 
 - (void)onDidDismissInAppMessage:(OSInAppMessageInternal *)message {
     if (self.inAppMessageDelegate &&
         [self.inAppMessageDelegate respondsToSelector:@selector(onDidDismissInAppMessage:)]) {
-        [self.inAppMessageDelegate onDidDismissInAppMessage:message];
+        OSInAppMessageDidDismissEvent *event = [[OSInAppMessageDidDismissEvent alloc] initWithInAppMessage:message];
+        [self.inAppMessageDelegate onDidDismissInAppMessage:event];
     }
 }
 

iOS_SDK/OneSignalSDK/Source/OneSignalInAppMessaging.h

@@ -82,12 +82,32 @@
 - (void)handleMessageAction:(OSInAppMessageAction * _Nonnull)action NS_SWIFT_NAME(handleMessageAction(action:));
 @end
 
-@protocol OSInAppMessageLifecycleHandler <NSObject>
+@interface OSInAppMessageWillDisplayEvent : NSObject
+@property (nonatomic, readonly, nonnull) OSInAppMessage *message;
+@end
+
+@interface OSInAppMessageDidDisplayEvent : NSObject
+@property (nonatomic, readonly, nonnull) OSInAppMessage *message;
+@end
+
+@interface OSInAppMessageWillDismissEvent : NSObject
+@property (nonatomic, readonly, nonnull) OSInAppMessage *message;
+@end
+
+@interface OSInAppMessageDidDismissEvent : NSObject
+@property (nonatomic, readonly, nonnull) OSInAppMessage *message;
+@end
+
+@protocol OSInAppMessageLifecycleListener <NSObject>
 @optional
-- (void)onWillDisplayInAppMessage:(OSInAppMessage *_Nonnull)message;
-- (void)onDidDisplayInAppMessage:(OSInAppMessage *_Nonnull)message;
-- (void)onWillDismissInAppMessage:(OSInAppMessage *_Nonnull)message;
-- (void)onDidDismissInAppMessage:(OSInAppMessage *_Nonnull)message;
+- (void)onWillDisplayInAppMessage:(OSInAppMessageWillDisplayEvent *_Nonnull)event
+NS_SWIFT_NAME(onWillDisplay(event:));
+- (void)onDidDisplayInAppMessage:(OSInAppMessageDidDisplayEvent *_Nonnull)event
+NS_SWIFT_NAME(onDidDisplay(event:));
+- (void)onWillDismissInAppMessage:(OSInAppMessageWillDismissEvent *_Nonnull)event
+NS_SWIFT_NAME(onWillDismiss(event:));
+- (void)onDidDismissInAppMessage:(OSInAppMessageDidDismissEvent *_Nonnull)event
+NS_SWIFT_NAME(onDidDismiss(event:));
 @end
 
 /**
@@ -106,8 +126,8 @@
 
 typedef void (^OSInAppMessageClickBlock)(OSInAppMessageAction * _Nonnull action);
 + (void)setClickHandler:(OSInAppMessageClickBlock _Nullable)block;
-+ (void)setLifecycleHandler:(NSObject<OSInAppMessageLifecycleHandler> *_Nullable)delegate;
-
++ (void)addLifecycleListener:(NSObject<OSInAppMessageLifecycleListener> *_Nullable)listener NS_REFINED_FOR_SWIFT;
++ (void)removeLifecycleListener:(NSObject<OSInAppMessageLifecycleListener> *_Nullable)listener NS_REFINED_FOR_SWIFT;
 @end
 
 @interface OneSignalInAppMessaging : NSObject <OSInAppMessages>

iOS_SDK/OneSignalSDK/Source/OneSignalInAppMessaging.m

@@ -44,9 +44,14 @@ + (void)setClickHandler:(OSInAppMessageClickBlock)block {
     [OSMessagingController.sharedInstance setInAppMessageClickHandler:block];
 }
 
-+ (void)setLifecycleHandler:(NSObject<OSInAppMessageLifecycleHandler> *_Nullable)delegate; {
-    [OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:@"In app message delegate set successfully"];
-    [OSMessagingController.sharedInstance setInAppMessageDelegate:delegate];
++ (void)addLifecycleListener:(NSObject<OSInAppMessageLifecycleListener> *_Nullable)listener {
+    [OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:@"In app message lifecycle listener added successfully"];
+    [OSMessagingController.sharedInstance setInAppMessageDelegate:listener];
+}
+
++ (void)removeLifecycleListener:(NSObject<OSInAppMessageLifecycleListener> *_Nullable)listener {
+    [OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:@"In app message lifecycle listener removed successfully"];
+    [OSMessagingController.sharedInstance removeInAppMessageDelegate:listener];
 }
 
 + (void)addTrigger:(NSString * _Nonnull)key withValue:(NSString * _Nonnull)value {

iOS_SDK/OneSignalSDK/Source/OneSignalSwiftInterface.swift

@@ -76,6 +76,14 @@ public extension OSInAppMessages {
             __paused(newValue)
         }
     }
+    
+    static func addLifecycleListener(_ listener: OSInAppMessageLifecycleListener) {
+        __add(listener)
+    }
+    
+    static func removeLifecycleListener(_ listener: OSInAppMessageLifecycleListener) {
+        __remove(listener)
+    }
 }
 
 public extension OSSession {