Merge pull request #171 from OneSignal/outcomes_release

Update for outcomes and release 3.6.0
OneSignal · Nov 5, 2019 · abe8fc0 · abe8fc0
2 parents 0f1f2c0 + c7a4d69
commit abe8fc0
Show file tree

Hide file tree

Showing 22 changed files with 330 additions and 114 deletions.
diff --git a/Com.OneSignal.Abstractions/Delegates.cs b/Com.OneSignal.Abstractions/Delegates.cs
@@ -23,4 +23,8 @@ namespace Com.OneSignal.Abstractions
 
    public delegate void OnSetEmailSuccess();
    public delegate void OnSetEmailFailure(Dictionary<string, object> response);
+
+   // SendOutcomeEventSuccess - Delegate is called when a SendOutcome(...), SendUniqueOutcome(...), or SendOutcomeWithValue(...) is sent successfully
+   // outcomeEvent = The OutcomeEvent created in native SDK and sent along with request using measure endpoint
+   public delegate void SendOutcomeEventSuccess(OSOutcomeEvent outcomeEvent);
 }
diff --git a/Com.OneSignal.Abstractions/IOneSignal.cs b/Com.OneSignal.Abstractions/IOneSignal.cs
@@ -44,6 +44,13 @@ public interface IOneSignal
       void RemoveTriggersForKeys(List<String> keys);
       object GetTriggerValueForKey(string key);
       void PauseInAppMessages(bool pause);
+
+      void SendOutcome(string name);
+      void SendOutcome(string name, SendOutcomeEventSuccess sendOutcomeEventSuccess);
+      void SendUniqueOutcome(string name);
+      void SendUniqueOutcome(string name, SendOutcomeEventSuccess sendOutcomeEventSuccess);
+      void SendOutcomeWithValue(string name, float value);
+      void SendOutcomeWithValue(string name, float value, SendOutcomeEventSuccess sendOutcomeEventSuccess);
    }
 }
 
diff --git a/Com.OneSignal.Abstractions/MiniJSON.cs b/Com.OneSignal.Abstractions/MiniJSON.cs
@@ -57,9 +57,7 @@ public static object Deserialize(string json)
         {
             // save the string for debug information
             if (json == null)
-            {
-                return null;
-            }
+               return null;
 
             return Parser.Parse(json);
         }

diff --git a/Com.OneSignal.Abstractions/OSOutcomeEvent.cs b/Com.OneSignal.Abstractions/OSOutcomeEvent.cs
@@ -0,0 +1,72 @@
+using System;
+using System.Collections.Generic;
+
+namespace Com.OneSignal.Abstractions
+{
+   public class OSOutcomeEvent
+   {
+
+      public enum OSSession
+      {
+         DIRECT,
+         INDIRECT,
+         UNATTRIBUTED,
+         DISABLED
+      }
+
+      public OSSession session = OSSession.DISABLED;
+      public List<string> notificationIds = new List<string>();
+      public string name = "";
+      public long timestamp = 0;
+      public double weight = 0;
+
+      public OSOutcomeEvent() {}
+
+      public OSOutcomeEvent(Dictionary<string, object> outcomeObject)
+      {
+         // session;
+         if (outcomeObject.ContainsKey("session"))
+            this.session = SessionFromString(outcomeObject["session"] as string);
+
+         // notificationIds
+         if (outcomeObject.ContainsKey("notification_ids")) {
+            List<object> idObjects = outcomeObject["notification_ids"] as List<object>;
+            List<string> ids = new List<string>();
+            foreach (var id in idObjects)
+                  ids.Add(id.ToString());
+
+            this.notificationIds = ids;
+         }
+
+         // id
+         if (outcomeObject.ContainsKey("id"))
+            this.name = outcomeObject["id"] as string;
+
+         // timestamp
+         if (outcomeObject.ContainsKey("timestamp"))
+            this.timestamp = (long) outcomeObject["timestamp"];
+
+         // weight
+         if (outcomeObject.ContainsKey("weight")) {
+            if (outcomeObject["weight"] is Int64)
+                  this.weight = (Int64) outcomeObject["weight"];
+            if (outcomeObject["weight"] is Double)
+                  this.weight = (Double) outcomeObject["weight"];
+         }
+
+      }
+
+      public static OSSession SessionFromString(string session)
+      {
+         session = session.ToLower();
+         if (session == "direct")
+            return OSSession.DIRECT;
+         if (session == "indirect")
+            return OSSession.INDIRECT;
+         if (session == "unattributed")
+            return OSSession.UNATTRIBUTED;
+
+         return OSSession.DISABLED;
+      }
+   }
+}
diff --git a/Com.OneSignal.Abstractions/OneSignalShared.cs b/Com.OneSignal.Abstractions/OneSignalShared.cs
@@ -32,8 +32,6 @@ public XamarinBuilder StartInit(string appId)
       [Obsolete("SyncHashedEmail has been deprecated. Please use SetEmail() instead.")]
       public abstract void SyncHashedEmail(string email);
 
-
-
       // logging
       public LOG_LEVEL logLevel = LOG_LEVEL.INFO, visualLogLevel = LOG_LEVEL.NONE;
 
@@ -116,5 +114,18 @@ public void OnInAppMessageClicked(OSInAppMessageAction action)
       public abstract object GetTriggerValueForKey(string key);
 
       public abstract void PauseInAppMessages(bool pause);
-	}
+
+      public abstract void SendOutcome(string name);
+
+      public abstract void SendOutcome(string name, SendOutcomeEventSuccess sendOutcomeEventSuccess);
+
+      public abstract void SendUniqueOutcome(string name);
+
+      public abstract void SendUniqueOutcome(string name, SendOutcomeEventSuccess sendOutcomeEventSuccess);
+
+      public abstract void SendOutcomeWithValue(string name, float value);
+
+      public abstract void SendOutcomeWithValue(string name, float value, SendOutcomeEventSuccess sendOutcomeEventSuccess);
+
+   }
 }
diff --git a/Com.OneSignal.Abstractions/Properties/AssemblyInfo.cs b/Com.OneSignal.Abstractions/Properties/AssemblyInfo.cs
@@ -17,7 +17,7 @@
 // The form "{Major}.{Minor}.*" will automatically update the build and revision,
 // and "{Major}.{Minor}.{Build}.*" will update just the revision.
 
-[assembly: AssemblyVersion("3.5.0")]
+[assembly: AssemblyVersion("3.6.0")]
 
 // The following attributes are used to specify the signing key for the assembly, 
 // if desired. See the Mono documentation for more information about signing.

diff --git a/Com.OneSignal.Android/OneSignalImplementation.cs b/Com.OneSignal.Android/OneSignalImplementation.cs
@@ -196,5 +196,35 @@ public override void PauseInAppMessages(bool pause)
       {
          Android.OneSignal.PauseInAppMessages(pause);
       }
+
+      public override void SendOutcome(string name)
+      {
+         Android.OneSignal.SendOutcome(name);
+      }
+
+      public override void SendOutcome(string name, SendOutcomeEventSuccess sendOutcomeEventSuccess)
+      {
+         Android.OneSignal.SendOutcome(name, new SendOutcomeEventSuccessHandler(sendOutcomeEventSuccess));
+      }
+
+      public override void SendUniqueOutcome(string name)
+      {
+         Android.OneSignal.SendUniqueOutcome(name);
+      }
+
+      public override void SendUniqueOutcome(string name, SendOutcomeEventSuccess sendOutcomeEventSuccess)
+      {
+         Android.OneSignal.SendUniqueOutcome(name, new SendOutcomeEventSuccessHandler(sendOutcomeEventSuccess));
+      }
+
+      public override void SendOutcomeWithValue(string name, float value)
+      {
+         Android.OneSignal.SendOutcomeWithValue(name, value);
+      }
+
+      public override void SendOutcomeWithValue(string name, float value, SendOutcomeEventSuccess sendOutcomeEventSuccess)
+      {
+         Android.OneSignal.SendOutcomeWithValue(name, value, new SendOutcomeEventSuccessHandler(sendOutcomeEventSuccess));
+      }
    }
 }
diff --git a/Com.OneSignal.Android/PostNotificationResponseHandler.cs b/Com.OneSignal.Android/PostNotificationResponseHandler.cs
@@ -7,35 +7,35 @@ namespace Com.OneSignal
 {
     public class PostNotificationResponseHandler : Java.Lang.Object, Android.OneSignal.IPostNotificationResponseHandler
     {
-		readonly OnPostNotificationSuccess _success;
-		readonly OnPostNotificationFailure _failure;
+	      readonly OnPostNotificationSuccess _success;
+	      readonly OnPostNotificationFailure _failure;
 
-		public PostNotificationResponseHandler(OnPostNotificationSuccess success, OnPostNotificationFailure failure)
-		{
-			_success = success;
-			_failure = failure;
-		}
+		   public PostNotificationResponseHandler(OnPostNotificationSuccess success, OnPostNotificationFailure failure)
+		   {
+			   _success = success;
+			   _failure = failure;
+		   }
 
-        public void OnSuccess(JSONObject jsonObject)
-        {
-			if (_success == null)
-				return;
+         public void OnSuccess(JSONObject jsonObject)
+         {
+		      if (_success == null)
+               return;
 
-            Dictionary<string, object> dict = null;
-            if (jsonObject != null)
-                dict = Json.Deserialize(jsonObject.ToString()) as Dictionary<string, object>;
-			_success(dict);
-        }
+               Dictionary<string, object> dict = null;
+               if (jsonObject != null)
+                  dict = Json.Deserialize(jsonObject.ToString()) as Dictionary<string, object>;
+		      _success(dict);
+         }
 
-        public void OnFailure(JSONObject jsonObject)
-        {
-			if (_failure == null)
-				return;
+         public void OnFailure(JSONObject jsonObject)
+         {
+	         if (_failure == null)
+		         return;
 
-            Dictionary<string, object> dict = null;
-            if (jsonObject != null)
-                dict = Json.Deserialize(jsonObject.ToString()) as Dictionary<string, object>;
-			_failure(dict);
-        }
+               Dictionary<string, object> dict = null;
+               if (jsonObject != null)
+                  dict = Json.Deserialize(jsonObject.ToString()) as Dictionary<string, object>;
+	         _failure(dict);
+         }
     }
 }
diff --git a/Com.OneSignal.Android/Properties/AssemblyInfo.cs b/Com.OneSignal.Android/Properties/AssemblyInfo.cs
@@ -17,7 +17,7 @@
 // The form "{Major}.{Minor}.*" will automatically update the build and revision,
 // and "{Major}.{Minor}.{Build}.*" will update just the revision.
 
-[assembly: AssemblyVersion("3.5.0")]
+[assembly: AssemblyVersion("3.6.0")]
 
 // The following attributes are used to specify the signing key for the assembly, 
 // if desired. See the Mono documentation for more information about signing.

diff --git a/Com.OneSignal.Android/SendOutcomeEventSuccessHandler.cs b/Com.OneSignal.Android/SendOutcomeEventSuccessHandler.cs
@@ -0,0 +1,33 @@
+using System;
+using System.Collections.Generic;
+using Com.OneSignal.Abstractions;
+using Com.OneSignal.Android;
+
+namespace Com.OneSignal
+{
+   public class SendOutcomeEventSuccessHandler : Java.Lang.Object, Android.OneSignal.IOutcomeCallback
+   {
+
+      readonly SendOutcomeEventSuccess _sendOutcomeEventSuccess;
+
+	   public SendOutcomeEventSuccessHandler(SendOutcomeEventSuccess sendOutcomeEventSuccess) => _sendOutcomeEventSuccess = sendOutcomeEventSuccess;
+
+      public void OnSuccess(OutcomeEvent outcome)
+      {
+         OSOutcomeEvent outcomeEvent = OSSendOutcomeEventSuccessToNative(outcome);
+         _sendOutcomeEventSuccess(outcomeEvent);
+      }
+
+      private static OSOutcomeEvent OSSendOutcomeEventSuccessToNative(OutcomeEvent outcome)
+      {
+         if (outcome == null)
+            return new OSOutcomeEvent();
+
+         Dictionary<string, object> outcomeObject = Json.Deserialize(outcome.ToJSONObject().ToString()) as Dictionary<string, object>;
+
+         OSOutcomeEvent outcomeEvent = new OSOutcomeEvent(outcomeObject);
+
+         return outcomeEvent;
+      }
+   }
+}
diff --git a/Com.OneSignal.Android/TagsHandler.cs b/Com.OneSignal.Android/TagsHandler.cs
@@ -5,21 +5,21 @@
 
 namespace Com.OneSignal
 {
-    public class TagsHandler : Java.Lang.Object, Android.OneSignal.IGetTagsHandler
-    {
-		readonly TagsReceived _tagsReceived;
+   public class TagsHandler : Java.Lang.Object, Android.OneSignal.IGetTagsHandler
+   {
+	   readonly TagsReceived _tagsReceived;
 
-		public TagsHandler(TagsReceived tagsReceived) => _tagsReceived = tagsReceived;
+	   public TagsHandler(TagsReceived tagsReceived) => _tagsReceived = tagsReceived;
 
-        public void TagsAvailable(JSONObject jsonObject)
-        {
-			if (_tagsReceived == null)
-				return;
+      public void TagsAvailable(JSONObject jsonObject)
+      {
+		   if (_tagsReceived == null)
+			   return;
 
             Dictionary<string, object> dict = null;
             if (jsonObject != null)
-                dict = Json.Deserialize(jsonObject.ToString()) as Dictionary<string, object>;
-			_tagsReceived(dict);
-        }
-    }
+               dict = Json.Deserialize(jsonObject.ToString()) as Dictionary<string, object>;
+		   _tagsReceived(dict);
+      }
+   }
 }
diff --git a/Com.OneSignal.iOS/OneSignalImplementation.cs b/Com.OneSignal.iOS/OneSignalImplementation.cs
@@ -39,14 +39,14 @@ private OSNotificationOpenedResult OSNotificationOpenedResultToXam(iOS.OSNotific
          return openresult;
       }
 
-    private OSNotification OSNotificationToXam(iOS.OSNotification notif)
-    {
-      var notification = new OSNotification();
-      notification.displayType = (OSNotification.DisplayType)notif.DisplayType;
-      notification.shown = notif.Shown;
-      notification.silentNotification = notif.SilentNotification;
-      notification.isAppInFocus = notif.IsAppInFocus;
-      notification.payload = new OSNotificationPayload();
+      private OSNotification OSNotificationToXam(iOS.OSNotification notif)
+      {
+         var notification = new OSNotification();
+         notification.displayType = (OSNotification.DisplayType)notif.DisplayType;
+         notification.shown = notif.Shown;
+         notification.silentNotification = notif.SilentNotification;
+         notification.isAppInFocus = notif.IsAppInFocus;
+         notification.payload = new OSNotificationPayload();
 
 
          notification.payload.actionButtons = new List<Dictionary<string, object>>();
@@ -358,5 +358,35 @@ public override void PauseInAppMessages(bool pause)
       {
          iOS.OneSignal.PauseInAppMessages(pause);
       }
+
+      public override void SendOutcome(string name)
+      {
+         Debug.WriteLine("Method SendOutcome() has has not been implemented yet!");
+      }
+
+      public override void SendOutcome(string name, SendOutcomeEventSuccess sendOutcomeEventSuccess)
+      {
+         Debug.WriteLine("Method SendOutcome() has has not been implemented yet!");
+      }
+
+      public override void SendUniqueOutcome(string name)
+      {
+         Debug.WriteLine("Method SendUniqueOutcome() has has not been implemented yet!");
+      }
+
+      public override void SendUniqueOutcome(string name, SendOutcomeEventSuccess sendOutcomeEventSuccess)
+      {
+         Debug.WriteLine("Method SendUniqueOutcome() has has not been implemented yet!");
+      }
+
+      public override void SendOutcomeWithValue(string name, float value)
+      {
+         Debug.WriteLine("Method SendOutcomeWithValue() has has not been implemented yet!");
+      }
+
+      public override void SendOutcomeWithValue(string name, float value, SendOutcomeEventSuccess sendOutcomeEventSuccess)
+      {
+         Debug.WriteLine("Method SendOutcomeWithValue() has has not been implemented yet!");
+      }
    }
 }
diff --git a/Com.OneSignal.iOS/Properties/AssemblyInfo.cs b/Com.OneSignal.iOS/Properties/AssemblyInfo.cs
@@ -17,7 +17,7 @@
 // The form "{Major}.{Minor}.*" will automatically update the build and revision,
 // and "{Major}.{Minor}.{Build}.*" will update just the revision.
 
-[assembly: AssemblyVersion("3.5.0")]
+[assembly: AssemblyVersion("3.6.0")]
 
 // The following attributes are used to specify the signing key for the assembly, 
 // if desired. See the Mono documentation for more information about signing.

diff --git a/Com.OneSignal.nuspec b/Com.OneSignal.nuspec
@@ -2,7 +2,7 @@
 <package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
     <metadata>
         <id>Com.OneSignal</id>
-        <version>3.5.0</version>
+        <version>3.6.0</version>
         <title>OneSignal SDK for Xamarin</title>
         <authors>OneSignal, Martijn van Dijk</authors>
         <owners>OneSignal</owners>