Merge pull request #84 from OneSignal/email

Adds Email to the Unity SDK

Author: Nightsd01

OneSignalExample/Assets/OneSignal/Example/GameControllerExample.cs

@@ -34,6 +34,7 @@
 public class GameControllerExample : MonoBehaviour {
 
    private static string extraMessage;
+   public string email = "Email Address";
 
    void Start () {
       extraMessage = null;
@@ -54,23 +55,29 @@ void Start () {
       OneSignal.inFocusDisplayType = OneSignal.OSInFocusDisplayOption.Notification;
       OneSignal.permissionObserver += OneSignal_permissionObserver;
       OneSignal.subscriptionObserver += OneSignal_subscriptionObserver;
+      OneSignal.emailSubscriptionObserver += OneSignal_emailSubscriptionObserver;
 
       var pushState = OneSignal.GetPermissionSubscriptionState();
       Debug.Log("pushState.subscriptionStatus.subscribed : " + pushState.subscriptionStatus.subscribed);
       Debug.Log("pushState.subscriptionStatus.userId : " + pushState.subscriptionStatus.userId);
    }
 
    private void OneSignal_subscriptionObserver(OSSubscriptionStateChanges stateChanges) {
-      Debug.Log("stateChanges: " + stateChanges);
-      Debug.Log("stateChanges.to.userId: " + stateChanges.to.userId);
-      Debug.Log("stateChanges.to.subscribed: " + stateChanges.to.subscribed);
+	  Debug.Log("SUBSCRIPTION stateChanges: " + stateChanges);
+	  Debug.Log("SUBSCRIPTION stateChanges.to.userId: " + stateChanges.to.userId);
+	  Debug.Log("SUBSCRIPTION stateChanges.to.subscribed: " + stateChanges.to.subscribed);
    }
 
-   private void OneSignal_permissionObserver(OSPermissionStateChanges stateChanges) {
-	  Debug.Log("stateChanges.from.status: " + stateChanges.from.status);
-      Debug.Log("stateChanges.to.status: " + stateChanges.to.status);
+	private void OneSignal_permissionObserver(OSPermissionStateChanges stateChanges) {
+	  Debug.Log("PERMISSION stateChanges.from.status: " + stateChanges.from.status);
+	  Debug.Log("PERMISSION stateChanges.to.status: " + stateChanges.to.status);
    }
 
+	private void OneSignal_emailSubscriptionObserver(OSEmailSubscriptionStateChanges stateChanges) {
+		Debug.Log("EMAIL stateChanges.from.status: " + stateChanges.from.emailUserId + ", " + stateChanges.from.emailAddress);
+		Debug.Log("EMAIL stateChanges.to.status: " + stateChanges.to.emailUserId + ", " + stateChanges.to.emailAddress);
+	}
+
    // Called when your app is in focus and a notificaiton is recieved.
    // The name of the method can be anything as long as the signature matches.
    // Method must be static or this object should be marked as DontDestroyOnLoad
@@ -107,11 +114,11 @@ public static void HandleNotificationOpened(OSNotificationOpenedResult result) {
          Debug.Log("[HandleNotificationOpened] message "+ message +", additionalData: "+ Json.Serialize(additionalData) as string);
 
       if (actionID != null) {
-            // actionSelected equals the id on the button the user pressed.
-            // actionSelected will equal "__DEFAULT__" when the notification itself was tapped when buttons were present.
-            extraMessage = "Pressed ButtonId: " + actionID;
-         }
-   }
+         // actionSelected equals the id on the button the user pressed.
+         // actionSelected will equal "__DEFAULT__" when the notification itself was tapped when buttons were present.
+         extraMessage = "Pressed ButtonId: " + actionID;
+      }
+	}
 
    // Test Menu
    // Includes SendTag/SendTags, getting the userID and pushToken, and scheduling an example notification
@@ -122,9 +129,24 @@ void OnGUI () {
       GUIStyle guiBoxStyle = new GUIStyle("box");
       guiBoxStyle.fontSize = 30;
 
-      GUI.Box(new Rect(10, 10, 390, 340), "Test Menu", guiBoxStyle);
+      GUIStyle textFieldStyle = new GUIStyle ("textField");
+      textFieldStyle.fontSize = 30;
+
+
+      float itemOriginX = 50.0f;
+      float itemWidth = Screen.width - 120.0f;
+      float boxWidth = Screen.width - 20.0f;
+      float boxOriginY = 120.0f;
+      float boxHeight = 630.0f;
+      float itemStartY = 200.0f;
+      float itemHeightOffset = 90.0f;
+      float itemHeight = 60.0f;
+
+      GUI.Box(new Rect(10, boxOriginY, boxWidth, boxHeight), "Test Menu", guiBoxStyle);
+
+      float count = 0.0f;
 
-      if (GUI.Button (new Rect (60, 80, 300, 60), "SendTags", customTextSize)) {
+      if (GUI.Button (new Rect (itemOriginX, itemStartY + (count * itemHeightOffset), itemWidth, itemHeight), "SendTags", customTextSize)) {
          // You can tags users with key value pairs like this:
          OneSignal.SendTag("UnityTestKey", "TestValue");
          // Or use an IDictionary if you need to set more than one tag.
@@ -136,13 +158,18 @@ void OnGUI () {
          // OneSignal.DeleteTags(new List<string>() {"UnityTestKey2", "UnityTestKey3" });
       }
 
-      if (GUI.Button (new Rect (60, 170, 300, 60), "GetIds", customTextSize)) {
-            OneSignal.IdsAvailable((userId, pushToken) => {
+      count++;
+
+      if (GUI.Button (new Rect (itemOriginX, itemStartY + (count * itemHeightOffset), itemWidth, itemHeight), "GetIds", customTextSize)) {
+         OneSignal.IdsAvailable((userId, pushToken) => {
             extraMessage = "UserID:\n" + userId + "\n\nPushToken:\n" + pushToken;
          });
       }
 
-      if (GUI.Button (new Rect (60, 260, 300, 60), "TestNotification", customTextSize)) {
+
+      count++;
+
+      if (GUI.Button (new Rect (itemOriginX, itemStartY + (count * itemHeightOffset), itemWidth, itemHeight), "TestNotification", customTextSize)) {
          extraMessage = "Waiting to get a OneSignal userId. Uncomment OneSignal.SetLogLevel in the Start method if it hangs here to debug the issue.";
          OneSignal.IdsAvailable((userId, pushToken) => {
             if (pushToken != null) {
@@ -158,21 +185,50 @@ void OnGUI () {
                notification["send_after"] = System.DateTime.Now.ToUniversalTime().AddSeconds(30).ToString("U");
 
                extraMessage = "Posting test notification now.";
+
                OneSignal.PostNotification(notification, (responseSuccess) => {
                   extraMessage = "Notification posted successful! Delayed by about 30 secounds to give you time to press the home button to see a notification vs an in-app alert.\n" + Json.Serialize(responseSuccess);
                }, (responseFailure) => {
                   extraMessage = "Notification failed to post:\n" + Json.Serialize(responseFailure);
                });
-            }
-            else
+            } else {
                extraMessage = "ERROR: Device is not registered.";
+            }
+         });
+      }
+
+      count++;
+
+      email = GUI.TextField (new Rect (itemOriginX, itemStartY + (count * itemHeightOffset), itemWidth, itemHeight), email, customTextSize);
+
+      count++;
+
+      if (GUI.Button (new Rect (itemOriginX, itemStartY + (count * itemHeightOffset), itemWidth, itemHeight), "SetEmail", customTextSize)) {
+         extraMessage = "Setting email to " + email;
+
+         OneSignal.SetEmail (email, () => {
+            Debug.Log("Successfully set email");
+         }, (error) => {
+            Debug.Log("Encountered error setting email: " + Json.Serialize(error));
+         });
+      }
+
+      count++;
+
+      if (GUI.Button (new Rect (itemOriginX, itemStartY + (count * itemHeightOffset), itemWidth, itemHeight), "LogoutEmail", customTextSize)) {
+         extraMessage = "Logging Out of [email protected]";
+         
+         OneSignal.LogoutEmail (() => {
+            Debug.Log("Successfully logged out of email");
+         }, (error) => {
+            Debug.Log("Encountered error logging out of email: " + Json.Serialize(error));
          });
       }
 
       if (extraMessage != null) {
          guiBoxStyle.alignment = TextAnchor.UpperLeft;
          guiBoxStyle.wordWrap = true;
-         GUI.Box (new Rect (10, 390, Screen.width - 20, Screen.height - 400), extraMessage, guiBoxStyle);
+         GUI.Box (new Rect (10, boxOriginY + boxHeight + 20, Screen.width - 20, Screen.height - (boxOriginY + boxHeight + 40)), extraMessage, guiBoxStyle);
       }
    }
 }

OneSignalExample/Assets/OneSignal/Platforms/Android/onesignal-unity.aar

@@ -50,6 +50,11 @@
 #import <UserNotifications/UserNotifications.h>
 #endif
 
+
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wstrict-prototypes"
+#pragma clang diagnostic ignored "-Wnullability-completeness"
+
 /* The action type associated to an OSNotificationAction object */
 typedef NS_ENUM(NSUInteger, OSNotificationActionType)  {
     OSNotificationActionTypeOpened,
@@ -236,26 +241,42 @@ typedef NS_ENUM(NSInteger, OSNotificationPermission) {
 
 @end
 
-@interface OSSubscriptionStateChanges : NSObject
 
+@interface OSEmailSubscriptionState : NSObject
+@property (readonly, nonatomic) NSString* emailUserId; // The new Email user ID
+@property (readonly, nonatomic) NSString *emailAddress;
+@property (readonly, nonatomic) BOOL subscribed;
+- (NSDictionary*)toDictionary;
+@end
+
+@interface OSSubscriptionStateChanges : NSObject
 @property (readonly) OSSubscriptionState* to;
 @property (readonly) OSSubscriptionState* from;
-
 - (NSDictionary*)toDictionary;
+@end
 
+@interface OSEmailSubscriptionStateChanges : NSObject
+@property (readonly) OSEmailSubscriptionState* to;
+@property (readonly) OSEmailSubscriptionState* from;
+- (NSDictionary*)toDictionary;
 @end
 
 @protocol OSSubscriptionObserver <NSObject>
 - (void)onOSSubscriptionChanged:(OSSubscriptionStateChanges*)stateChanges;
 @end
 
+@protocol OSEmailSubscriptionObserver <NSObject>
+- (void)onOSEmailSubscriptionChanged:(OSEmailSubscriptionStateChanges*)stateChanges;
+@end
+
 
 
 // Permission+Subscription Classes
 @interface OSPermissionSubscriptionState : NSObject
 
 @property (readonly) OSPermissionState* permissionStatus;
 @property (readonly) OSSubscriptionState* subscriptionStatus;
+@property (readonly) OSEmailSubscriptionState *emailSubscriptionStatus;
 - (NSDictionary*)toDictionary;
 
 @end
@@ -341,7 +362,6 @@ typedef NS_ENUM(NSUInteger, ONE_S_LOG_LEVEL) {
 + (void)deleteTags:(NSArray*)keys onSuccess:(OSResultSuccessBlock)successBlock onFailure:(OSFailureBlock)failureBlock;
 + (void)deleteTags:(NSArray*)keys;
 + (void)deleteTagsWithJsonString:(NSString*)jsonString;
-
 // Optional method that sends us the user's email as an anonymized hash so that we can better target and personalize notifications sent to that user across their devices.
 // Sends as MD5 and SHA1 of the provided email
 + (void)syncHashedEmail:(NSString*)email;
@@ -357,6 +377,9 @@ typedef NS_ENUM(NSUInteger, ONE_S_LOG_LEVEL) {
 + (void)addSubscriptionObserver:(NSObject<OSSubscriptionObserver>*)observer;
 + (void)removeSubscriptionObserver:(NSObject<OSSubscriptionObserver>*)observer;
 
++ (void)addEmailSubscriptionObserver:(NSObject<OSEmailSubscriptionObserver>*)observer;
++ (void)removeEmailSubscriptionObserver:(NSObject<OSEmailSubscriptionObserver>*)observer;
+
 + (void)setSubscription:(BOOL)enable;
 
 // - Posting Notification
@@ -380,4 +403,29 @@ typedef NS_ENUM(NSUInteger, ONE_S_LOG_LEVEL) {
 + (UNMutableNotificationContent*)didReceiveNotificationExtensionRequest:(UNNotificationRequest*)request withMutableNotificationContent:(UNMutableNotificationContent*)replacementContent;
 + (UNMutableNotificationContent*)serviceExtensionTimeWillExpireRequest:(UNNotificationRequest*)request withMutableNotificationContent:(UNMutableNotificationContent*)replacementContent;
 
+// Email methods
+
+// Typedefs defining completion blocks for email & simultaneous HTTP requests
+typedef void (^OSEmailFailureBlock)(NSError* error);
+typedef void (^OSEmailSuccessBlock)();
+
+// Allows you to set the email for this user.
+// Email Auth Token is a (recommended) optional parameter that should *NOT* be generated on the client.
+// For security purposes, the emailAuthToken should be generated by your backend server.
+// If you do not have a backend server for your application, use the version of thge setEmail: method without an emailAuthToken parameter.
++ (void)setEmail:(NSString * _Nonnull)email withEmailAuthHashToken:(NSString * _Nullable)hashToken withSuccess:(OSEmailSuccessBlock _Nullable)successBlock withFailure:(OSEmailFailureBlock _Nullable)failureBlock;
+
+// Sets email without an authentication token
++ (void)setEmail:(NSString * _Nonnull)email withSuccess:(OSEmailSuccessBlock _Nullable)successBlock withFailure:(OSEmailFailureBlock _Nullable)failureBlock;
+
+// Logs the device out of the current email.
++ (void)logoutEmailWithSuccess:(OSEmailSuccessBlock _Nullable)successBlock withFailure:(OSEmailFailureBlock _Nullable)failureBlock;
+
+//convenience - no completion blocks
++ (void)logoutEmail;
++ (void)setEmail:(NSString * _Nonnull)email;
++ (void)setEmail:(NSString * _Nonnull)email withEmailAuthHashToken:(NSString * _Nullable)hashToken;
+
 @end
+
+#pragma clang diagnostic pop

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

@@ -88,7 +88,8 @@ static void injectSelector(Class newClass, SEL newSel, Class addToClass, SEL mak
 
 @interface OSUnityPermissionAndSubscriptionObserver : NSObject<OSPermissionObserver, OSSubscriptionObserver>
 - (void)onOSPermissionChanged:(OSPermissionStateChanges*)stateChanges;
-- (void)onOSSubscriptionChanged:(OSSubscriptionStateChanges*)stateChanges;
+- (void)onOSSubscriptionChanged:(OSSubscriptionStateChanges*)stateChanges;
+- (void)onOSEmailSubscriptionChanged:(OSEmailSubscriptionStateChanges *)stateChanges;
 @end
 
 @implementation OSUnityPermissionAndSubscriptionObserver
@@ -98,6 +99,10 @@ - (void)onOSPermissionChanged:(OSPermissionStateChanges*)stateChanges {
 
 - (void)onOSSubscriptionChanged:(OSSubscriptionStateChanges*)stateChanges {
   UnitySendMessage(unityListener, "onOSSubscriptionChanged", dictionaryToJsonChar([stateChanges toDictionary]));
+}
+
+- (void)onOSEmailSubscriptionStateChanged:(OSEmailSubscriptionStateChanges *)stateChanges {
+    UnitySendMessage(unityListener, "onOSEmailSubscriptionStateChanged", dictionaryToJsonChar([stateChanges toDictionary]));
 }
 @end
 
@@ -273,6 +278,17 @@ void _addSubscriptionObserver() {
 
 void _removeSubscriptionObserver() {
   [OneSignal removeSubscriptionObserver:osUnityObserver];
+}
+
+void _addEmailSubscriptionObserver() {
+    if (!osUnityObserver)
+        osUnityObserver = [OSUnityPermissionAndSubscriptionObserver alloc];
+    
+    [OneSignal addEmailSubscriptionObserver:osUnityObserver];
+}
+
+void _removeEmailSubscriptionObserver() {
+    [OneSignal removeEmailSubscriptionObserver:osUnityObserver];
 }
 
 char* _getPermissionSubscriptionState() {
@@ -287,6 +303,32 @@ void _promptForPushNotificationsWithUserResponse() {
 
 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"}));
+    } withFailure:^(NSError *error) {
+        UnitySendMessage(unityListener, "onSetEmailFailure", [[OneSignal parseNSErrorAsJsonString:error] UTF8String]);
+    }];
+}
+
+void _setEmail(const char *email, const char *emailAuthCode) {
+    [OneSignal setEmail:CreateNSString(email) withEmailAuthHashToken:CreateNSString(emailAuthCode) withSuccess:^{
+        UnitySendMessage(unityListener, "onSetEmailSuccess", dictionaryToJsonChar(@{@"status" : @"success"}));
+    } withFailure:^(NSError *error) {
+        UnitySendMessage(unityListener, "onSetEmailFailure", [[OneSignal parseNSErrorAsJsonString:error] UTF8String]);
+    }];
+}
+
+void _logoutEmail() {
+    [OneSignal logoutEmailWithSuccess:^{
+        UnitySendMessage(unityListener, "onLogoutEmailSuccess", dictionaryToJsonChar(@{@"status" : @"success"}));
+    } withFailure:^(NSError *error) {
+        UnitySendMessage(unityListener, "onLogoutEmailFailure", [[OneSignal parseNSErrorAsJsonString:error] UTF8String]);
+    }];
 }
 
 @end