Merge pull request #224 from OneSignal/iam-ios

IAM functionality added

Author: mikechoch

OneSignalExample/Assets/OneSignal/Editor/PostProcessBuildPlayer_iOS.cs

@@ -34,8 +34,11 @@ public static void OnPostProcessBuild(BuildTarget target, string path)
          string targetName = PBXProject.GetUnityTargetName();
          string targetGUID = project.TargetGuidByName(targetName);
 
-         // UserNotifications.framework is required by libOneSignal.a
-         project.AddFrameworkToProject(targetGUID, "UserNotifications.framework", false);
+         var frameworks = new string[] {"NotificationCenter.framework", "UserNotifications.framework", "UIKit.framework", "SystemConfiguration.framework", "CoreGraphics.framework", "WebKit.framework"};
+
+         foreach (string framework in frameworks) {
+            project.AddFrameworkToProject (targetGUID, framework, false);
+         }
 
          #if UNITY_2017_2_OR_NEWER && !UNITY_CLOUD_BUILD
 
@@ -63,8 +66,6 @@ public static void OnPostProcessBuild(BuildTarget target, string path)
             project.AddFileToBuild (notificationServiceTarget, project.AddFile (sourceDestination + ".h", sourceDestination + ".h", PBXSourceTree.Source));
             project.AddFileToBuild (notificationServiceTarget, project.AddFile (sourceDestination + ".m", sourceDestination + ".m", PBXSourceTree.Source));
 
-            var frameworks = new string[] {"NotificationCenter.framework", "UserNotifications.framework", "UIKit.framework", "SystemConfiguration.framework"};
-
             foreach (string framework in frameworks) {
                project.AddFrameworkToProject (notificationServiceTarget, framework, true);
             }

OneSignalExample/Assets/OneSignal/Example/GameControllerExample.cs

@@ -1,4 +1,4 @@
-/**
+/**
  * Modified MIT License
  * 
  * Copyright 2016 OneSignal
@@ -76,7 +76,10 @@ private void OneSignalInAppMessageTriggerExamples() {
       OneSignal.AddTrigger("key", "value");
 
       // Get the current value to a trigger by key
-      var triggerValue = OneSignal.GetTriggerValueForKey("key");
+      var triggerKey = "key";
+      var triggerValue = OneSignal.GetTriggerValueForKey(triggerKey);
+      String output = "Trigger key: " + triggerKey + " value: " + (String) triggerValue;
+      Console.WriteLine(output);
 
       // Add multiple triggers
       OneSignal.AddTriggers(new Dictionary<string, object>() { { "key1", "value1" }, { "key2", 2 } });
@@ -151,7 +154,12 @@ public static void HandleNotificationOpened(OSNotificationOpenedResult result) {
 	}
 
    public static void HandlerInAppMessageClicked(OSInAppMessageAction action) {
-      String logInAppClickEvent = "In-App Message opened with action.clickName " + action.clickName;
+      String logInAppClickEvent = "In-App Message Clicked: " +
+            "\nClick Name: " + action.clickName +
+            "\nClick Url: " + action.clickUrl +
+            "\nFirst Click: " + action.firstClick +
+            "\nCloses Message: " + action.closesMessage;
+
       print(logInAppClickEvent);
       extraMessage = logInAppClickEvent;
    }

OneSignalExample/Assets/OneSignal/Platforms/iOS/OneSignal.h

@@ -44,12 +44,7 @@
 ***/
 
 #import <Foundation/Foundation.h>
-
-#if __IPHONE_OS_VERSION_MAX_ALLOWED >= 100000
-#define XC8_AVAILABLE 1
 #import <UserNotifications/UserNotifications.h>
-#endif
-
 
 #pragma clang diagnostic push
 #pragma clang diagnostic ignored "-Wstrict-prototypes"
@@ -73,6 +68,26 @@ typedef NS_ENUM(NSUInteger, OSNotificationDisplayType) {
     OSNotificationDisplayTypeNotification
 };
 
+@interface OSInAppMessageAction : NSObject
+
+// The action name attached to the IAM action
+@property (strong, nonatomic, nullable) NSString *clickName;
+
+// The URL (if any) that should be opened when the action occurs
+@property (strong, nonatomic, nullable) NSURL *clickUrl;
+
+// Whether or not the click action is first click on the IAM
+@property (nonatomic) BOOL firstClick;
+
+// Whether or not the click action dismisses the message
+@property (nonatomic) BOOL closesMessage;
+
+@end
+
+@protocol OSInAppMessageDelegate <NSObject>
+@optional
+- (void)handleMessageAction:(OSInAppMessageAction * _Nonnull)action NS_SWIFT_NAME(handleMessageAction(action:));
+@end
 
 @interface OSNotificationAction : NSObject
 
@@ -133,7 +148,7 @@ typedef NS_ENUM(NSUInteger, OSNotificationDisplayType) {
 @property(readonly)NSString* subtitle;
 @property(readonly)NSString* body;
 
-/* Web address to launch within the app via a UIWebView */
+/* Web address to launch within the app via a WKWebView */
 @property(readonly)NSString* launchURL;
 
 /* Additional key value properties set within the payload */
@@ -181,11 +196,8 @@ typedef NS_ENUM(NSUInteger, OSNotificationDisplayType) {
 @property(readonly, getter=isSilentNotification)BOOL silentNotification;
 
 /* iOS 10+: Indicates whether or not the received notification has mutableContent : 1 assigned to its payload
- Used for UNNotificationServiceExtension to launch extension.
-*/
-#if XC8_AVAILABLE
+ Used for UNNotificationServiceExtension to launch extension. */
 @property(readonly, getter=hasMutableContent)BOOL mutableContent;
-#endif
 
 /* Convert object into an NSString that can be convertible into a custom Dictionary / JSON Object */
 - (NSString*)stringify;
@@ -218,16 +230,6 @@ typedef NS_ENUM(NSInteger, OSNotificationPermission) {
     OSNotificationPermissionProvisional
 };
 
-typedef void (^OSNotificationDisplayTypeResponse)(OSNotificationDisplayType displayType);
-
-// Notification Display Type Delegate
-// Allows apps to customize per-notification display-type
-@protocol OSNotificationDisplayTypeDelegate <NSObject>
-- (void)willPresentInFocusNotificationWithPayload:(OSNotificationPayload *)payload
-                                   withCompletion:(OSNotificationDisplayTypeResponse)completion;
-@end
-
-
 // Permission Classes
 @interface OSPermissionState : NSObject
 
@@ -318,6 +320,9 @@ typedef void (^OSHandleNotificationReceivedBlock)(OSNotification* notification);
 /*Block for handling a user reaction to a notification*/
 typedef void (^OSHandleNotificationActionBlock)(OSNotificationOpenedResult * result);
 
+/*Block for handling user click on an in app message*/
+typedef void (^OSHandleInAppMessageActionClickBlock)(OSInAppMessageAction* action);
+
 /*Dictionary of keys to pass alongside the init settings*/
 
 /*Let OneSignal directly prompt for push notifications on init*/
@@ -415,10 +420,6 @@ typedef NS_ENUM(NSUInteger, ONE_S_LOG_LEVEL) {
 
 + (OSPermissionSubscriptionState*)getPermissionSubscriptionState;
 
-// When the app is in-focus, this allows you to add a delegate that can customize the
-// display type for specific notifications
-+ (void)setNotificationDisplayTypeDelegate:(NSObject<OSNotificationDisplayTypeDelegate>*)delegate;
-
 + (void)addPermissionObserver:(NSObject<OSPermissionObserver>*)observer;
 + (void)removePermissionObserver:(NSObject<OSPermissionObserver>*)observer;
 
@@ -429,6 +430,8 @@ typedef NS_ENUM(NSUInteger, ONE_S_LOG_LEVEL) {
 + (void)removeEmailSubscriptionObserver:(NSObject<OSEmailSubscriptionObserver>*)observer;
 
 + (void)setSubscription:(BOOL)enable;
++ (BOOL)isInAppMessagingPaused;
++ (void)pauseInAppMessages:(BOOL)pause;
 
 // - Posting Notification
 + (void)postNotification:(NSDictionary*)jsonData;
@@ -444,6 +447,7 @@ typedef NS_ENUM(NSUInteger, ONE_S_LOG_LEVEL) {
 // Only used for wrapping SDKs, such as Unity, Cordova, Xamarin, etc.
 + (void)setMSDKType:(NSString*)type;
 
++ (void)setInAppMessageClickHandler:(OSHandleInAppMessageActionClickBlock)delegate;
 
 // iOS 10 only
 // Process from Notification Service Extension.
@@ -474,6 +478,14 @@ typedef void (^OSEmailSuccessBlock)();
 + (void)setEmail:(NSString * _Nonnull)email;
 + (void)setEmail:(NSString * _Nonnull)email withEmailAuthHashToken:(NSString * _Nullable)hashToken;
 
+// In App Messaging Trigger methods
++ (void)addTrigger:(NSString * _Nonnull)key withValue:(id _Nonnull)value;
++ (void)addTriggers:(NSDictionary<NSString *, id> * _Nonnull)triggers;
++ (void)removeTriggerForKey:(NSString * _Nonnull)key;
++ (void)removeTriggersForKeys:(NSArray<NSString *> * _Nonnull)keys;
++ (NSDictionary<NSString *, id> * _Nonnull)getTriggers;
++ (id _Nullable)getTriggerValueForKey:(NSString * _Nonnull)key;
+
 + (void)setExternalUserId:(NSString * _Nonnull)externalId;
 + (void)removeExternalUserId;
 

OneSignalExample/Assets/OneSignal/Platforms/iOS/OneSignalUnityRuntime.m

@@ -28,6 +28,16 @@
 #import "OneSignal.h"
 #import <objc/runtime.h>
 
+char* cStringCopy(const char* string) {
+    if (string == NULL)
+        return NULL;
+    
+    char* res = (char*)malloc(strlen(string) + 1);
+    strcpy(res, string);
+    
+    return res;
+}
+
 NSString* CreateNSString(const char* string) {
     return [NSString stringWithUTF8String: string ? string : ""];
 }
@@ -117,7 +127,7 @@ + (void)load {
 static Class delegateClass = nil;
 
 - (void) setOneSignalUnityDelegate:(id<UIApplicationDelegate>)delegate {
-    if(delegateClass) {
+    if (delegateClass) {
         [self setOneSignalUnityDelegate:delegate];
         return;
     }
@@ -146,6 +156,20 @@ void processNotificationReceived(NSString* notificationString) {
     UnitySendMessage(unityListener, "onPushNotificationReceived", [notificationString UTF8String]);
 }
 
+void processInAppMessageClicked(char* inAppMessageActionString) {
+    UnitySendMessage(unityListener, "onInAppMessageClicked", inAppMessageActionString);
+}
+
+char* createInAppMessageJsonString(OSInAppMessageAction* action) {
+    return cStringCopy(dictionaryToJsonChar(
+  @{
+    @"click_name" : action.clickName,
+    @"click_url" : action.clickUrl ? action.clickUrl.absoluteString : @"",
+    @"first_click" : @(action.firstClick),
+    @"closes_message" : @(action.closesMessage)
+    }));
+}
+
 void initOneSignalObject(NSDictionary* launchOptions, const char* appId, int displayOption, BOOL inAppLaunchURL, BOOL autoPrompt, BOOL fromColdStart) {
 
     NSString* appIdStr = (appId ? [NSString stringWithUTF8String: appId] : nil);
@@ -165,6 +189,9 @@ void initOneSignalObject(NSDictionary* launchOptions, const char* appId, int dis
                      kOSSettingsKeyInAppLaunchURL: @(inAppLaunchURL),
                      @"kOSSettingsKeyInOmitNoAppIdLogging": @(fromColdStart)}];
 
+    [OneSignal setInAppMessageClickHandler:^(OSInAppMessageAction* action) {
+        processInAppMessageClicked(createInAppMessageJsonString(action));
+    }];
 }
 
 void _init(const char* listenerName, const char* appId, BOOL autoPrompt, BOOL inAppLaunchURL, int displayOption, int logLevel, int visualLogLevel, bool requiresUserPrivacyConsent) {
@@ -192,13 +219,13 @@ void _sendTag(const char* tagName, const char* tagValue) {
 }
 
 void _sendTags(const char* tags) {
-    NSString * jsonString = CreateNSString(tags);
+    NSString* jsonString = CreateNSString(tags);
 
     NSError* jsonError;
 
     NSData* data = [jsonString dataUsingEncoding:NSUTF8StringEncoding];
     NSDictionary* keyValuePairs = [NSJSONSerialization JSONObjectWithData:data options:kNilOptions error:&jsonError];
-    if (jsonError == nil)
+    if (!jsonError)
         [OneSignal sendTags:keyValuePairs];
 }
 
@@ -207,13 +234,13 @@ void _deleteTag(const char* key) {
 }
 
 void _deleteTags(const char* keys) {
-    NSString * jsonString = CreateNSString(keys);
+    NSString* jsonString = CreateNSString(keys);
 
     NSError* jsonError;
 
     NSData* data = [jsonString dataUsingEncoding:NSUTF8StringEncoding];
     NSArray* kk = [NSJSONSerialization JSONObjectWithData:data options:NSJSONReadingMutableContainers error:&jsonError];
-    if (jsonError == nil)
+    if (!jsonError)
         [OneSignal deleteTags:kk];
 }
 
@@ -225,7 +252,7 @@ void _getTags() {
 
 void _idsAvailable() {
     [OneSignal IdsAvailable:^(NSString* userId, NSString* pushToken) {
-        if (pushToken == nil)
+        if (!pushToken)
             pushToken = @"";
 
         UnitySendMessage(unityListener, "onIdsAvailable",
@@ -238,12 +265,12 @@ void _setSubscription(BOOL enable) {
 }
 
 void _postNotification(const char* jsonData) {
-    NSString * jsonString = CreateNSString(jsonData);
+    NSString* jsonString = CreateNSString(jsonData);
     NSError* jsonError;
 
     NSData* data = [jsonString dataUsingEncoding:NSUTF8StringEncoding];
     NSDictionary* jsd = [NSJSONSerialization JSONObjectWithData:data options:kNilOptions error:&jsonError];
-    if (jsonError == nil)
+    if (!jsonError)
         [OneSignal postNotification:jsd onSuccess:^(NSDictionary* results) {
             UnitySendMessage(unityListener, "onPostNotificationSuccess", dictionaryToJsonChar(results));
         } onFailure:^(NSError* error) {
@@ -309,8 +336,6 @@ void _setOneSignalLogLevel(int logLevel, int visualLogLevel) {
     [OneSignal setLogLevel:logLevel visualLevel: visualLogLevel];
 }
 
-// email
-
 void _setUnauthenticatedEmail(const char*email) {
     [OneSignal setEmail:CreateNSString(email) withSuccess:^{
         UnitySendMessage(unityListener, "onSetEmailSuccess", dictionaryToJsonChar(@{@"status" : @"success"}));
@@ -359,4 +384,41 @@ void _removeExternalUserId() {
     [OneSignal removeExternalUserId];
 }
 
+void _addTriggers(char *triggers) {
+    NSString* jsonString = CreateNSString(triggers);
+    
+    NSError* jsonError;
+    
+    NSData* data = [jsonString dataUsingEncoding:NSUTF8StringEncoding];
+    NSDictionary* triggerKeyValuePairs = [NSJSONSerialization JSONObjectWithData:data options:kNilOptions error:&jsonError];
+    if (!jsonError)
+        [OneSignal addTriggers:triggerKeyValuePairs];
+}
+
+void _removeTriggerForKey(char *key) {
+    NSString* triggerKey = CreateNSString(key);
+    [OneSignal removeTriggerForKey:triggerKey];
+}
+
+void _removeTriggersForKeys(char *keys) {
+    NSString* jsonString = CreateNSString(keys);
+    
+    NSError* jsonError;
+    
+    NSData* data = [jsonString dataUsingEncoding:NSUTF8StringEncoding];
+    NSArray* triggerKeys = [NSJSONSerialization JSONObjectWithData:data options:NSJSONReadingMutableContainers error:&jsonError];
+    if (!jsonError)
+        [OneSignal removeTriggersForKeys:triggerKeys];
+}
+
+char* _getTriggerValueForKey(char *key) {
+    NSString* triggerKey = CreateNSString(key);
+    NSDictionary* triggerValue = @{ @"value" : [OneSignal getTriggerValueForKey:triggerKey] };
+    return cStringCopy(dictionaryToJsonChar(triggerValue));
+}
+
+void _pauseInAppMessages(bool pause) {
+    [OneSignal pauseInAppMessages:pause];
+}
+
 @end

OneSignalExample/Assets/OneSignal/Platforms/iOS/libOneSignal.a

@@ -648,23 +648,20 @@ public static bool UserProvidedConsent() {
 #endif
    }
 
-   public static void SetRequiresUserPrivacyConsent(bool required)
-   {
+   public static void SetRequiresUserPrivacyConsent(bool required) {
 #if ONESIGNAL_PLATFORM
          OneSignal.requiresUserConsent = required;
 #endif
    }
 
 
-   public static void SetExternalUserId(string externalId)
-   {
+    public static void SetExternalUserId(string externalId) {
 #if ONESIGNAL_PLATFORM
       oneSignalPlatform.SetExternalUserId(externalId);
 #endif
    }
 
-   public static void RemoveExternalUserId()
-   {
+   public static void RemoveExternalUserId() {
 #if ONESIGNAL_PLATFORM
       oneSignalPlatform.RemoveExternalUserId();
 #endif