Merge pull request #1278 from OneSignal/5.0.0/support_multiple_listeners

nan-li · web-flow · commit 208bc8d64ea2 · 2023-07-19T14:36:47.000-07:00
[5.0.0] Support multiple IAM + Notification Lifecycle Listeners
diff --git a/iOS_SDK/OneSignalDevApp/OneSignalExample.xcodeproj/xcshareddata/xcschemes/OneSignalExample.xcscheme b/iOS_SDK/OneSignalDevApp/OneSignalExample.xcodeproj/xcshareddata/xcschemes/OneSignalExample.xcscheme
@@ -0,0 +1,78 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Scheme
+   LastUpgradeVersion = "1410"
+   version = "1.3">
+   <BuildAction
+      parallelizeBuildables = "YES"
+      buildImplicitDependencies = "YES">
+      <BuildActionEntries>
+         <BuildActionEntry
+            buildForTesting = "YES"
+            buildForRunning = "YES"
+            buildForProfiling = "YES"
+            buildForArchiving = "YES"
+            buildForAnalyzing = "YES">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "9112E8811E724C320022A1CB"
+               BuildableName = "OneSignalExample.app"
+               BlueprintName = "OneSignalExample"
+               ReferencedContainer = "container:OneSignalExample.xcodeproj">
+            </BuildableReference>
+         </BuildActionEntry>
+      </BuildActionEntries>
+   </BuildAction>
+   <TestAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      shouldUseLaunchSchemeArgsEnv = "YES">
+      <Testables>
+      </Testables>
+   </TestAction>
+   <LaunchAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      launchStyle = "0"
+      useCustomWorkingDirectory = "NO"
+      ignoresPersistentStateOnLaunch = "NO"
+      debugDocumentVersioning = "YES"
+      debugServiceExtension = "internal"
+      allowLocationSimulation = "YES">
+      <BuildableProductRunnable
+         runnableDebuggingMode = "0">
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "9112E8811E724C320022A1CB"
+            BuildableName = "OneSignalExample.app"
+            BlueprintName = "OneSignalExample"
+            ReferencedContainer = "container:OneSignalExample.xcodeproj">
+         </BuildableReference>
+      </BuildableProductRunnable>
+   </LaunchAction>
+   <ProfileAction
+      buildConfiguration = "Release"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      savedToolIdentifier = ""
+      useCustomWorkingDirectory = "NO"
+      debugDocumentVersioning = "YES">
+      <BuildableProductRunnable
+         runnableDebuggingMode = "0">
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "9112E8811E724C320022A1CB"
+            BuildableName = "OneSignalExample.app"
+            BlueprintName = "OneSignalExample"
+            ReferencedContainer = "container:OneSignalExample.xcodeproj">
+         </BuildableReference>
+      </BuildableProductRunnable>
+   </ProfileAction>
+   <AnalyzeAction
+      buildConfiguration = "Debug">
+   </AnalyzeAction>
+   <ArchiveAction
+      buildConfiguration = "Release"
+      revealArchiveInOrganizer = "YES">
+   </ArchiveAction>
+</Scheme>
diff --git a/iOS_SDK/OneSignalSDK/OneSignalCore/Source/OSInAppMessages.h b/iOS_SDK/OneSignalSDK/OneSignalCore/Source/OSInAppMessages.h
@@ -33,7 +33,7 @@
 
 @property (strong, nonatomic, nonnull) NSString *messageId;
 
-// Convert the object into a NSDictionary
+// Dictionary of properties available on OSInAppMessage only
 - (NSDictionary *_Nonnull)jsonRepresentation;
 
 @end
@@ -78,18 +78,22 @@ typedef NS_ENUM(NSUInteger, OSInAppMessageActionUrlType) {
 
 @interface OSInAppMessageWillDisplayEvent : NSObject
 @property (nonatomic, readonly, nonnull) OSInAppMessage *message;
+- (NSDictionary *_Nonnull)jsonRepresentation;
 @end
 
 @interface OSInAppMessageDidDisplayEvent : NSObject
 @property (nonatomic, readonly, nonnull) OSInAppMessage *message;
+- (NSDictionary *_Nonnull)jsonRepresentation;
 @end
 
 @interface OSInAppMessageWillDismissEvent : NSObject
 @property (nonatomic, readonly, nonnull) OSInAppMessage *message;
+- (NSDictionary *_Nonnull)jsonRepresentation;
 @end
 
 @interface OSInAppMessageDidDismissEvent : NSObject
 @property (nonatomic, readonly, nonnull) OSInAppMessage *message;
+- (NSDictionary *_Nonnull)jsonRepresentation;
 @end
 
 @interface OSInAppMessageClickEvent : NSObject
diff --git a/iOS_SDK/OneSignalSDK/OneSignalInAppMessages/Controller/OSMessagingController.h b/iOS_SDK/OneSignalSDK/OneSignalInAppMessages/Controller/OSMessagingController.h
@@ -66,8 +66,8 @@ NS_ASSUME_NONNULL_BEGIN
 
 - (void)addInAppMessageClickListener:(NSObject<OSInAppMessageClickListener> *_Nullable)listener;
 - (void)removeInAppMessageClickListener:(NSObject<OSInAppMessageClickListener> *_Nullable)listener;
-- (void)setInAppMessageDelegate:(NSObject<OSInAppMessageLifecycleListener> *_Nullable)delegate;
-- (void)removeInAppMessageDelegate:(NSObject<OSInAppMessageLifecycleListener> *_Nullable)delegate;
+- (void)addInAppMessageLifecycleListener:(NSObject<OSInAppMessageLifecycleListener> *_Nullable)listener;
+- (void)removeInAppMessageLifecycleListener:(NSObject<OSInAppMessageLifecycleListener> *_Nullable)listener;
 
 @end
 
diff --git a/iOS_SDK/OneSignalSDK/OneSignalInAppMessages/Controller/OSMessagingController.m b/iOS_SDK/OneSignalSDK/OneSignalInAppMessages/Controller/OSMessagingController.m
@@ -39,31 +39,63 @@
 #import "OSSessionManager.h"
 
 @implementation OSInAppMessageWillDisplayEvent
+
 - (OSInAppMessageWillDisplayEvent*)initWithInAppMessage:(OSInAppMessage *)message {
     _message = message;
     return self;
 }
+
+- (NSDictionary *)jsonRepresentation {
+    NSMutableDictionary *json = [NSMutableDictionary new];
+    json[@"message"] = [self.message jsonRepresentation];
+    return json;
+}
+
 @end
 
 @implementation OSInAppMessageDidDisplayEvent
+
 - (OSInAppMessageDidDisplayEvent*)initWithInAppMessage:(OSInAppMessage *)message {
     _message = message;
     return self;
 }
+
+- (NSDictionary *)jsonRepresentation {
+    NSMutableDictionary *json = [NSMutableDictionary new];
+    json[@"message"] = [self.message jsonRepresentation];
+    return json;
+}
+
 @end
 
 @implementation OSInAppMessageWillDismissEvent
+
 - (OSInAppMessageWillDismissEvent*)initWithInAppMessage:(OSInAppMessage *)message {
     _message = message;
     return self;
 }
+
+- (NSDictionary *)jsonRepresentation {
+    NSMutableDictionary *json = [NSMutableDictionary new];
+    json[@"message"] = [self.message jsonRepresentation];
+    return json;
+}
+
 @end
 
 @implementation OSInAppMessageDidDismissEvent
+
 - (OSInAppMessageDidDismissEvent*)initWithInAppMessage:(OSInAppMessage *)message {
     _message = message;
     return self;
 }
+
+- (NSDictionary *)jsonRepresentation {
+    NSMutableDictionary *json = [NSMutableDictionary new];
+    json[@"message"] = [self.message jsonRepresentation];
+    return json;
+}
+
 @end
 
 @interface OSMessagingController ()
@@ -91,7 +123,7 @@ @interface OSMessagingController ()
 
 @property (nonatomic) NSMutableArray<NSObject<OSInAppMessageClickListener> *> *clickListeners;
 
-@property (weak, nonatomic, nullable) NSObject<OSInAppMessageLifecycleListener> *inAppMessageDelegate;
+@property (nonatomic) NSMutableArray<NSObject<OSInAppMessageLifecycleListener> *> *lifecycleListeners;
 
 @property (strong, nullable) OSInAppMessageViewController *viewController;
 
@@ -169,6 +201,7 @@ - (instancetype)init {
         [self initializeTriggerController];
         self.messageDisplayQueue = [NSMutableArray new];
         self.clickListeners = [NSMutableArray new];
+        self.lifecycleListeners = [NSMutableArray new];
         
         let standardUserDefaults = OneSignalUserDefaults.initStandard;
         
@@ -309,43 +342,47 @@ - (void)removeInAppMessageClickListener:(NSObject<OSInAppMessageClickListener> *
     [_clickListeners removeObject:listener];
 }
 
-- (void)setInAppMessageDelegate:(NSObject<OSInAppMessageLifecycleListener> *_Nullable)delegate {
-    _inAppMessageDelegate = delegate;
+- (void)addInAppMessageLifecycleListener:(NSObject<OSInAppMessageLifecycleListener> *_Nullable)listener {
+    [_lifecycleListeners addObject:listener];
 }
 
-- (void)removeInAppMessageDelegate:(NSObject<OSInAppMessageLifecycleListener> *_Nullable)delegate {
-    _inAppMessageDelegate = nil;
+- (void)removeInAppMessageLifecycleListener:(NSObject<OSInAppMessageLifecycleListener> *_Nullable)listener {
+    [_lifecycleListeners removeObject:listener];
 }
 
 - (void)onWillDisplayInAppMessage:(OSInAppMessageInternal *)message {
-    if (self.inAppMessageDelegate &&
-        [self.inAppMessageDelegate respondsToSelector:@selector(onWillDisplayInAppMessage:)]) {
-        OSInAppMessageWillDisplayEvent *event = [[OSInAppMessageWillDisplayEvent alloc] initWithInAppMessage:message];
-        [self.inAppMessageDelegate onWillDisplayInAppMessage:event];
+    for (NSObject<OSInAppMessageLifecycleListener> *listener in _lifecycleListeners) {
+        if ([listener respondsToSelector:@selector(onWillDisplayInAppMessage:)]) {
+            OSInAppMessageWillDisplayEvent *event = [[OSInAppMessageWillDisplayEvent alloc] initWithInAppMessage:message];
+            [listener onWillDisplayInAppMessage:event];
+        }
     }
 }
 
 - (void)onDidDisplayInAppMessage:(OSInAppMessageInternal *)message {
-    if (self.inAppMessageDelegate &&
-        [self.inAppMessageDelegate respondsToSelector:@selector(onDidDisplayInAppMessage:)]) {
-        OSInAppMessageDidDisplayEvent *event = [[OSInAppMessageDidDisplayEvent alloc] initWithInAppMessage:message];
-        [self.inAppMessageDelegate onDidDisplayInAppMessage:event];
+    for (NSObject<OSInAppMessageLifecycleListener> *listener in _lifecycleListeners) {
+        if ([listener respondsToSelector:@selector(onDidDisplayInAppMessage:)]) {
+            OSInAppMessageDidDisplayEvent *event = [[OSInAppMessageDidDisplayEvent alloc] initWithInAppMessage:message];
+            [listener onDidDisplayInAppMessage:event];
+        }
     }
 }
 
 - (void)onWillDismissInAppMessage:(OSInAppMessageInternal *)message {
-    if (self.inAppMessageDelegate &&
-        [self.inAppMessageDelegate respondsToSelector:@selector(onWillDismissInAppMessage:)]) {
-        OSInAppMessageWillDismissEvent *event = [[OSInAppMessageWillDismissEvent alloc] initWithInAppMessage:message];
-        [self.inAppMessageDelegate onWillDismissInAppMessage:event];
+    for (NSObject<OSInAppMessageLifecycleListener> *listener in _lifecycleListeners) {
+        if ([listener respondsToSelector:@selector(onWillDismissInAppMessage:)]) {
+            OSInAppMessageWillDismissEvent *event = [[OSInAppMessageWillDismissEvent alloc] initWithInAppMessage:message];
+            [listener onWillDismissInAppMessage:event];
+        }
     }
 }
 
 - (void)onDidDismissInAppMessage:(OSInAppMessageInternal *)message {
-    if (self.inAppMessageDelegate &&
-        [self.inAppMessageDelegate respondsToSelector:@selector(onDidDismissInAppMessage:)]) {
-        OSInAppMessageDidDismissEvent *event = [[OSInAppMessageDidDismissEvent alloc] initWithInAppMessage:message];
-        [self.inAppMessageDelegate onDidDismissInAppMessage:event];
+    for (NSObject<OSInAppMessageLifecycleListener> *listener in _lifecycleListeners) {
+        if ([listener respondsToSelector:@selector(onDidDismissInAppMessage:)]) {
+            OSInAppMessageDidDismissEvent *event = [[OSInAppMessageDidDismissEvent alloc] initWithInAppMessage:message];
+            [listener onDidDismissInAppMessage:event];
+        }
     }
 }
 
@@ -565,10 +602,10 @@ - (void)setDataForRedisplay:(OSInAppMessageInternal *)message {
     BOOL messageDismissed = [_seenInAppMessages containsObject:message.messageId];
     let redisplayMessageSavedData = [_redisplayedInAppMessages objectForKey:message.messageId];
 
-    [OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:[NSString stringWithFormat:@"Redisplay dismissed: %@ and data: %@", messageDismissed ? @"YES" : @"NO", redisplayMessageSavedData.jsonRepresentation.description]];
+    [OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:[NSString stringWithFormat:@"Redisplay dismissed: %@ and data: %@", messageDismissed ? @"YES" : @"NO", redisplayMessageSavedData.jsonRepresentationInternal.description]];
 
     if (messageDismissed && redisplayMessageSavedData) {
-        [OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:[NSString stringWithFormat:@"Redisplay IAM: %@", message.jsonRepresentation.description]];
+        [OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:[NSString stringWithFormat:@"Redisplay IAM: %@", message.jsonRepresentationInternal.description]];
         
         message.displayStats.displayQuantity = redisplayMessageSavedData.displayStats.displayQuantity;
         message.displayStats.lastDisplayTime = redisplayMessageSavedData.displayStats.lastDisplayTime;
diff --git a/iOS_SDK/OneSignalSDK/OneSignalInAppMessages/Model/OSInAppMessageClickEvent.m b/iOS_SDK/OneSignalSDK/OneSignalInAppMessages/Model/OSInAppMessageClickEvent.m
@@ -38,7 +38,7 @@ - (instancetype)initWithInAppMessage:(OSInAppMessageInternal *)message clickResu
 
 - (NSDictionary *)jsonRepresentation {
     let json = [NSMutableDictionary new];
-    json[@"message"] = self.message;
+    json[@"message"] = [self.message jsonRepresentation];
     json[@"result"] = [self.result jsonRepresentation];
     return json;
 }
diff --git a/iOS_SDK/OneSignalSDK/OneSignalInAppMessages/Model/OSInAppMessageInternal.h b/iOS_SDK/OneSignalSDK/OneSignalInAppMessages/Model/OSInAppMessageInternal.h
@@ -59,6 +59,8 @@ NS_ASSUME_NONNULL_BEGIN
 - (void)addClickId:(NSString *)clickId;
 
 - (BOOL)isFinished;
+// Dictionary of properties available on OSInAppMessageInternal
+- (NSDictionary *_Nonnull)jsonRepresentationInternal;
 
 @end
 
diff --git a/iOS_SDK/OneSignalSDK/OneSignalInAppMessages/Model/OSInAppMessageInternal.m b/iOS_SDK/OneSignalSDK/OneSignalInAppMessages/Model/OSInAppMessageInternal.m
@@ -165,7 +165,7 @@ + (instancetype)instancePreviewFromNotification:(OSNotification *)notification {
     return message;
 }
 
--(NSDictionary *)jsonRepresentation {
+- (NSDictionary *)jsonRepresentationInternal {
     let json = [NSMutableDictionary new];
     
     json[@"messageId"] = self.messageId;
diff --git a/iOS_SDK/OneSignalSDK/OneSignalInAppMessages/OneSignalInAppMessages.m b/iOS_SDK/OneSignalSDK/OneSignalInAppMessages/OneSignalInAppMessages.m
@@ -64,12 +64,12 @@ + (void)removeClickListener:(NSObject<OSInAppMessageClickListener> *_Nullable)li
 
 + (void)addLifecycleListener:(NSObject<OSInAppMessageLifecycleListener> *_Nullable)listener {
     [OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:@"In app message lifecycle listener added successfully"];
-    [OSMessagingController.sharedInstance setInAppMessageDelegate:listener];
+    [OSMessagingController.sharedInstance addInAppMessageLifecycleListener: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];
+    [OSMessagingController.sharedInstance removeInAppMessageLifecycleListener:listener];
 }
 
 + (void)addTrigger:(NSString * _Nonnull)key withValue:(NSString * _Nonnull)value {
diff --git a/iOS_SDK/OneSignalSDK/OneSignalNotifications/OSNotificationsManager.h b/iOS_SDK/OneSignalSDK/OneSignalNotifications/OSNotificationsManager.h
@@ -80,7 +80,6 @@ NS_SWIFT_NAME(onClick(event:));
 @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;
diff --git a/iOS_SDK/OneSignalSDK/OneSignalNotifications/OSNotificationsManager.m b/iOS_SDK/OneSignalSDK/OneSignalNotifications/OSNotificationsManager.m
diff --git a/iOS_SDK/OneSignalSDK/UnitTests/OSInAppMessagingHelpers.m b/iOS_SDK/OneSignalSDK/UnitTests/OSInAppMessagingHelpers.m

Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ - (instancetype)initWithInAppMessage:(OSInAppMessageInternal *)message clickResu`
`38`	`38`
`39`	`39`	`- (NSDictionary *)jsonRepresentation {`
`40`	`40`	`let json = [NSMutableDictionary new];`
`41`		`- json[@"message"] = self.message;`
	`41`	`+ json[@"message"] = [self.message jsonRepresentation];`
`42`	`42`	`json[@"result"] = [self.result jsonRepresentation];`
`43`	`43`	`return json;`
`44`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -165,7 +165,7 @@ + (instancetype)instancePreviewFromNotification:(OSNotification *)notification {`
`165`	`165`	`return message;`
`166`	`166`	`}`
`167`	`167`
`168`		`--(NSDictionary *)jsonRepresentation {`
	`168`	`+- (NSDictionary *)jsonRepresentationInternal {`
`169`	`169`	`let json = [NSMutableDictionary new];`
`170`	`170`
`171`	`171`	`json[@"messageId"] = self.messageId;`
Original file line number	Diff line number	Diff line change
`@@ -64,12 +64,12 @@ + (void)removeClickListener:(NSObject<OSInAppMessageClickListener> *_Nullable)li`
`64`	`64`
`65`	`65`	`+ (void)addLifecycleListener:(NSObject<OSInAppMessageLifecycleListener> *_Nullable)listener {`
`66`	`66`	`[OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:@"In app message lifecycle listener added successfully"];`
`67`		`- [OSMessagingController.sharedInstance setInAppMessageDelegate:listener];`
	`67`	`+ [OSMessagingController.sharedInstance addInAppMessageLifecycleListener:listener];`
`68`	`68`	`}`
`69`	`69`
`70`	`70`	`+ (void)removeLifecycleListener:(NSObject<OSInAppMessageLifecycleListener> *_Nullable)listener {`
`71`	`71`	`[OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:@"In app message lifecycle listener removed successfully"];`
`72`		`- [OSMessagingController.sharedInstance removeInAppMessageDelegate:listener];`
	`72`	`+ [OSMessagingController.sharedInstance removeInAppMessageLifecycleListener:listener];`
`73`	`73`	`}`
`74`	`74`
`75`	`75`	`+ (void)addTrigger:(NSString * _Nonnull)key withValue:(NSString * _Nonnull)value {`