Splitting out lifecycle methods into OSInAppMessageLifecycleHandler

The IAM Lifecycle Methods will now match the Android naming of OSInAppMessageLifecycleHandler.

I am leaving the unused OSInAppMessageDelegate to avoid build failures in customer systems that might erroneously be using the protocol.

Author: emawby

iOS_SDK/OneSignalDevApp/OneSignalDevApp/AppDelegate.h

@@ -31,7 +31,7 @@
 #import <UIKit/UIKit.h>
 #import <OneSignal/OneSignal.h>
 
-@interface AppDelegate : UIResponder <UIApplicationDelegate, OSPermissionObserver, OSSubscriptionObserver, OSEmailSubscriptionObserver, OSInAppMessageDelegate>
+@interface AppDelegate : UIResponder <UIApplicationDelegate, OSPermissionObserver, OSSubscriptionObserver, OSEmailSubscriptionObserver, OSInAppMessageLifecycleHandler>
 
 @property (strong, nonatomic) UIWindow *window;
 

iOS_SDK/OneSignalDevApp/OneSignalDevApp/AppDelegate.m

@@ -84,7 +84,7 @@ - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(
     [OneSignal addPermissionObserver:self];
     [OneSignal addSubscriptionObserver:self];
     [OneSignal addEmailSubscriptionObserver:self];
-    [OneSignal setInAppMessageDelegate:self];
+    [OneSignal setInAppMessageLifecycleHandler:self];
     [OneSignal pauseInAppMessages:true];
 
     [OneSignal setNotificationWillShowInForegroundHandler:notificationReceiverBlock];

iOS_SDK/OneSignalSDK/Source/OSMessagingController.h

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

iOS_SDK/OneSignalSDK/Source/OSMessagingController.m

@@ -69,7 +69,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<OSInAppMessageDelegate> *inAppMessageDelegate;
+@property (weak, nonatomic, nullable) NSObject<OSInAppMessageLifecycleHandler> *inAppMessageDelegate;
 
 @property (strong, nullable) OSInAppMessageViewController *viewController;
 
@@ -229,7 +229,7 @@ - (void)setInAppMessageClickHandler:(OSInAppMessageClickBlock)actionClickBlock {
     self.actionClickBlock = actionClickBlock;
 }
 
-- (void)setInAppMessageDelegate:(NSObject<OSInAppMessageDelegate> *_Nullable)delegate {
+- (void)setInAppMessageDelegate:(NSObject<OSInAppMessageLifecycleHandler> *_Nullable)delegate {
     _inAppMessageDelegate = delegate;
 }
 

iOS_SDK/OneSignalSDK/Source/OneSignal.h

@@ -214,6 +214,10 @@ typedef NS_ENUM(NSUInteger, OSNotificationActionType)  {
 @protocol OSInAppMessageDelegate <NSObject>
 @optional
 - (void)handleMessageAction:(OSInAppMessageAction * _Nonnull)action NS_SWIFT_NAME(handleMessageAction(action:));
+@end
+
+@protocol OSInAppMessageLifecycleHandler <NSObject>
+@optional
 - (void)onWillDisplayInAppMessage:(OSInAppMessage *)message;
 - (void)onDidDisplayInAppMessage:(OSInAppMessage *)message;
 - (void)onWillDismissInAppMessage:(OSInAppMessage *)message;
@@ -482,7 +486,7 @@ typedef void (^OSInAppMessageClickBlock)(OSInAppMessageAction * _Nonnull action)
 + (void)setNotificationWillShowInForegroundHandler:(OSNotificationWillShowInForegroundBlock _Nullable)block;
 + (void)setNotificationOpenedHandler:(OSNotificationOpenedBlock _Nullable)block;
 + (void)setInAppMessageClickHandler:(OSInAppMessageClickBlock _Nullable)block;
-+ (void)setInAppMessageDelegate:(NSObject<OSInAppMessageDelegate> *_Nullable)delegate;
++ (void)setInAppMessageLifecycleHandler:(NSObject<OSInAppMessageLifecycleHandler> *_Nullable)delegate;
 
 #pragma mark Post Notification
 + (void)postNotification:(NSDictionary* _Nonnull)jsonData;

iOS_SDK/OneSignalSDK/Source/OneSignal.m

@@ -721,7 +721,7 @@ + (void)setInAppMessageClickHandler:(OSInAppMessageClickBlock)block {
     [OSMessagingController.sharedInstance setInAppMessageClickHandler:block];
 }
 
-+ (void)setInAppMessageDelegate:(NSObject<OSInAppMessageDelegate> *_Nullable)delegate; {
++ (void)setInAppMessageLifecycleHandler:(NSObject<OSInAppMessageLifecycleHandler> *_Nullable)delegate; {
     [OneSignal onesignal_Log:ONE_S_LL_VERBOSE message:@"In app message delegate set successfully"];
     [OSMessagingController.sharedInstance setInAppMessageDelegate:delegate];
 }

iOS_SDK/OneSignalSDK/UnitTests/InAppMessagingIntegrationTests.m

@@ -1601,7 +1601,7 @@ - (void)testIAMLifecyleEventsFired {
     [self initOneSignalWithInAppMessage:message];
 
     OSInAppMessageTestDelegate *iamDelegate = [OSInAppMessageTestDelegate new];
-    [OneSignal setInAppMessageDelegate:iamDelegate];
+    [OneSignal setInAppMessageLifecycleHandler:iamDelegate];
 
     XCTAssertEqual(0, OSMessagingControllerOverrider.messageDisplayQueue.count);
 

iOS_SDK/OneSignalSDK/UnitTests/UnitTestCommonMethods.h

@@ -123,7 +123,7 @@ withNotificationWillShowInForegroundHandler:(OSNotificationWillShowInForegroundB
 - (void)onOSSMSSubscriptionChanged:(OSSMSSubscriptionStateChanges *)stateChanges;
 @end
 
-@interface OSInAppMessageTestDelegate : NSObject<OSInAppMessageDelegate> {
+@interface OSInAppMessageTestDelegate : NSObject<OSInAppMessageLifecycleHandler> {
     @package OSInAppMessage *lastMessageWillDisplay;
     @package OSInAppMessage *lastMessageDidDisplay;
     @package OSInAppMessage *lastMessageWillDismiss;