Merge pull request #104 from OneSignal/gdpr_privacy

Gdpr privacy

Author: Nightsd01

OneSignalExample/Assets/OneSignal/Example/GameControllerExample.cs

@@ -36,14 +36,21 @@ public class GameControllerExample : MonoBehaviour {
    private static string extraMessage;
    public string email = "Email Address";
 
+   private static bool requiresUserPrivacyConsent = false;
+
    void Start () {
       extraMessage = null;
 
       // Enable line below to debug issues with setuping OneSignal. (logLevel, visualLogLevel)
       OneSignal.SetLogLevel(OneSignal.LOG_LEVEL.VERBOSE, OneSignal.LOG_LEVEL.NONE);
 
+      // If you set to true, the user will have to provide consent
+      // using OneSignal.UserDidProvideConsent(true) before the
+      // SDK will initialize
+      OneSignal.SetRequiresUserPrivacyConsent(requiresUserPrivacyConsent);
+
       // The only required method you need to call to setup OneSignal to receive push notifications.
-      // Call before using any other methods on OneSignal.
+      // Call before using any other methods on OneSignal (except setLogLevel or SetRequiredUserPrivacyConsent)
       // Should only be called once when your app is loaded.
       // OneSignal.Init(OneSignal_AppId);
       OneSignal.StartInit("b2f7f966-d8cc-11e4-bed1-df8f05be55ba")
@@ -58,8 +65,6 @@ void Start () {
       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) {
@@ -137,7 +142,7 @@ void OnGUI () {
       float itemWidth = Screen.width - 120.0f;
       float boxWidth = Screen.width - 20.0f;
       float boxOriginY = 120.0f;
-      float boxHeight = 630.0f;
+      float boxHeight = requiresUserPrivacyConsent ? 720.0f : 630.0f;
       float itemStartY = 200.0f;
       float itemHeightOffset = 90.0f;
       float itemHeight = 60.0f;
@@ -225,6 +230,16 @@ void OnGUI () {
          });
       }
 
+      if (requiresUserPrivacyConsent) {
+         count++;
+
+         if (GUI.Button (new Rect (itemOriginX, itemStartY + (count * itemHeightOffset), itemWidth, itemHeight), (OneSignal.UserProvidedConsent() ? "Revoke Privacy Consent" : "Provide Privacy Consent"), customTextSize)) {
+            extraMessage = "Providing user privacy consent";
+            
+            OneSignal.UserDidProvideConsent(!OneSignal.UserProvidedConsent());
+         }
+      }
+
       if (extraMessage != null) {
          guiBoxStyle.alignment = TextAnchor.UpperLeft;
          guiBoxStyle.wordWrap = true;

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

@@ -340,6 +340,11 @@ typedef NS_ENUM(NSUInteger, ONE_S_LOG_LEVEL) {
 + (id)initWithLaunchOptions:(NSDictionary*)launchOptions appId:(NSString*)appId handleNotificationAction:(OSHandleNotificationActionBlock)actionCallback settings:(NSDictionary*)settings;
 + (id)initWithLaunchOptions:(NSDictionary*)launchOptions appId:(NSString*)appId handleNotificationReceived:(OSHandleNotificationReceivedBlock)receivedCallback handleNotificationAction:(OSHandleNotificationActionBlock)actionCallback settings:(NSDictionary*)settings;
 
+// - Privacy
++ (void)consentGranted:(BOOL)granted;
++ (BOOL)requiresUserPrivacyConsent; // tells your application if privacy consent is still needed from the current user
++ (void)setRequiresUserPrivacyConsent:(BOOL)required; //used by wrapper SDK's to require user privacy consent
+
 @property (class) OSNotificationDisplayType inFocusDisplayType;
 
 + (NSString*)app_id;

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

@@ -165,7 +165,9 @@ void initOneSignalObject(NSDictionary* launchOptions, const char* appId, int dis
 
 }
 
-void _init(const char* listenerName, const char* appId, BOOL autoPrompt, BOOL inAppLaunchURL, int displayOption, int logLevel, int visualLogLevel) {
+void _init(const char* listenerName, const char* appId, BOOL autoPrompt, BOOL inAppLaunchURL, int displayOption, int logLevel, int visualLogLevel, bool requiresUserPrivacyConsent) {
+    [OneSignal setRequiresUserPrivacyConsent:requiresUserPrivacyConsent];
+    
     [OneSignal setLogLevel:logLevel visualLevel: visualLogLevel];
 
     unsigned long len = strlen(listenerName);
@@ -329,6 +331,18 @@ void _logoutEmail() {
     } withFailure:^(NSError *error) {
         UnitySendMessage(unityListener, "onLogoutEmailFailure", [[OneSignal parseNSErrorAsJsonString:error] UTF8String]);
     }];
+}
+
+void _userDidProvideConsent(bool consent) {
+    [OneSignal consentGranted:consent];
+}
+
+bool _userProvidedConsent() {
+    return ![OneSignal requiresUserPrivacyConsent];
+}
+
+void _setRequiresUserPrivacyConsent(bool required) {
+    [OneSignal setRequiresUserPrivacyConsent:required];
 }
 
 @end

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

@@ -303,6 +303,15 @@ public void EndInit() {
          OneSignal.Init();
       }
 
+      public UnityBuilder SetRequiresUserPrivacyConsent(bool required) {
+         System.Diagnostics.Debug.WriteLine("Did call setRequiresUserPrivacyConsent in OneSignal.cs");
+   #if ONESIGNAL_PLATFORM
+         OneSignal.requiresUserConsent = true;
+   #endif
+
+         return this;
+      }
+
    }
    internal static UnityBuilder builder = null;
 
@@ -314,6 +323,8 @@ public void EndInit() {
    private static LOG_LEVEL logLevel = LOG_LEVEL.INFO, visualLogLevel = LOG_LEVEL.NONE;
 #endif
 
+   internal static bool requiresUserConsent = false;
+
    internal static OnPostNotificationSuccess postNotificationSuccessDelegate = null;
    internal static OnPostNotificationFailure postNotificationFailureDelegate = null;
 
@@ -374,7 +385,7 @@ private static void initOneSignalPlatform() {
 
 #if ONESIGNAL_PLATFORM && UNITY_ANDROID
    private static void initAndroid() {
-      oneSignalPlatform = new OneSignalAndroid(gameObjectName, builder.googleProjectNumber, builder.appID, inFocusDisplayType, logLevel, visualLogLevel);
+      oneSignalPlatform = new OneSignalAndroid(gameObjectName, builder.googleProjectNumber, builder.appID, inFocusDisplayType, logLevel, visualLogLevel, requiresUserConsent);
    }
 #endif
 
@@ -388,7 +399,7 @@ private static void initIOS() {
          if (builder.iOSSettings.ContainsKey(kOSSettingsInAppLaunchURL))
             inAppLaunchURL = builder.iOSSettings[kOSSettingsInAppLaunchURL];
       }
-      oneSignalPlatform = new OneSignalIOS(gameObjectName, builder.appID, autoPrompt, inAppLaunchURL, inFocusDisplayType, logLevel, visualLogLevel);
+      oneSignalPlatform = new OneSignalIOS(gameObjectName, builder.appID, autoPrompt, inAppLaunchURL, inFocusDisplayType, logLevel, visualLogLevel, requiresUserConsent);
    }
 #endif
 
@@ -598,6 +609,28 @@ public static OSPermissionSubscriptionState GetPermissionSubscriptionState() {
 #endif
    }
 
+   
+
+   public static void UserDidProvideConsent(bool consent) {
+#if ONESIGNAL_PLATFORM
+      oneSignalPlatform.UserDidProvideConsent(consent);
+#endif
+   }
+
+   public static bool UserProvidedConsent() {
+#if ONESIGNAL_PLATFORM
+      return oneSignalPlatform.UserProvidedConsent();
+#else
+      return true;
+#endif
+   }
+
+   public static void SetRequiresUserPrivacyConsent(bool required) {
+      #if ONESIGNAL_PLATFORM
+         OneSignal.requiresUserConsent = required;
+      #endif
+   }
+
    /*** protected and private methods ****/
 #if ONESIGNAL_PLATFORM
 

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

@@ -34,8 +34,8 @@
 public class OneSignalAndroid : OneSignalPlatform {
    private static AndroidJavaObject mOneSignal = null;
 
-   public OneSignalAndroid(string gameObjectName, string googleProjectNumber, string appId, OneSignal.OSInFocusDisplayOption displayOption, OneSignal.LOG_LEVEL logLevel, OneSignal.LOG_LEVEL visualLevel) {
-      mOneSignal = new AndroidJavaObject("com.onesignal.OneSignalUnityProxy", gameObjectName, googleProjectNumber, appId, (int)logLevel, (int)visualLevel);
+   public OneSignalAndroid(string gameObjectName, string googleProjectNumber, string appId, OneSignal.OSInFocusDisplayOption displayOption, OneSignal.LOG_LEVEL logLevel, OneSignal.LOG_LEVEL visualLevel, bool requiresUserConsent) {
+      mOneSignal = new AndroidJavaObject("com.onesignal.OneSignalUnityProxy", gameObjectName, googleProjectNumber, appId, (int)logLevel, (int)visualLevel, requiresUserConsent);
       SetInFocusDisplaying(displayOption);
    }
 
@@ -127,6 +127,18 @@ public void removeEmailSubscriptionObserver() {
       mOneSignal.Call("removeEmailSubscriptionObserver");
    }
 
+   public void UserDidProvideConsent(bool consent) {
+      mOneSignal.Call("provideUserConsent", consent);
+   }
+
+   public bool UserProvidedConsent() {
+      return mOneSignal.Call<bool>("userProvidedPrivacyConsent");
+   }
+
+   public void SetRequiresUserPrivacyConsent(bool required) {
+      mOneSignal.Call("setRequiresUserPrivacyConsent", required);
+   }
+
    public OSPermissionSubscriptionState getPermissionSubscriptionState() {
       return OneSignalPlatformHelper.parsePermissionSubscriptionState(this, mOneSignal.Call<string>("getPermissionSubscriptionState"));
    }

OneSignalExample/Assets/OneSignal/src/OneSignal.cs

@@ -35,7 +35,7 @@
 public class OneSignalIOS : OneSignalPlatform {
 
    [System.Runtime.InteropServices.DllImport("__Internal")]
-   extern static public void _init(string listenerName, string appId, bool autoPrompt, bool inAppLaunchURLs, int displayOption, int logLevel, int visualLogLevel);
+   extern static public void _init(string listenerName, string appId, bool autoPrompt, bool inAppLaunchURLs, int displayOption, int logLevel, int visualLogLevel, bool requiresUserPrivacyConsent);
 
    [System.Runtime.InteropServices.DllImport("__Internal")]
    extern static public void _registerForPushNotifications();
@@ -109,9 +109,18 @@ public class OneSignalIOS : OneSignalPlatform {
    [System.Runtime.InteropServices.DllImport("__Internal")]
    extern static public void _setOneSignalLogLevel(int logLevel, int visualLogLevel);
 
+   [System.Runtime.InteropServices.DllImport("__Internal")]
+   extern static public void _userDidProvideConsent(bool consent);
+
+   [System.Runtime.InteropServices.DllImport("__Internal")]
+   extern static public bool _userProvidedConsent();
+
+   [System.Runtime.InteropServices.DllImport("__Internal")]
+   extern static public void _setRequiresUserPrivacyConsent(bool required);   
+
 
-   public OneSignalIOS(string gameObjectName, string appId, bool autoPrompt, bool inAppLaunchURLs, OneSignal.OSInFocusDisplayOption displayOption, OneSignal.LOG_LEVEL logLevel, OneSignal.LOG_LEVEL visualLevel) {
-       _init(gameObjectName, appId, autoPrompt, inAppLaunchURLs, (int)displayOption, (int)logLevel, (int)visualLevel);
+   public OneSignalIOS(string gameObjectName, string appId, bool autoPrompt, bool inAppLaunchURLs, OneSignal.OSInFocusDisplayOption displayOption, OneSignal.LOG_LEVEL logLevel, OneSignal.LOG_LEVEL visualLevel, bool requiresUserPrivacyConsent) {
+       _init(gameObjectName, appId, autoPrompt, inAppLaunchURLs, (int)displayOption, (int)logLevel, (int)visualLevel, requiresUserPrivacyConsent);
    }
 
    public void RegisterForPushNotifications() {
@@ -207,6 +216,18 @@ public void LogoutEmail() {
       _logoutEmail();
    }
 
+   public void UserDidProvideConsent(bool consent) {
+      _userDidProvideConsent(consent);
+   }
+
+   public bool UserProvidedConsent() {
+      return _userProvidedConsent();
+   }
+
+   public void SetRequiresUserPrivacyConsent(bool required) {
+      _setRequiresUserPrivacyConsent(required);
+   }
+
    public OSPermissionSubscriptionState getPermissionSubscriptionState() {
       return OneSignalPlatformHelper.parsePermissionSubscriptionState(this, _getPermissionSubscriptionState());
    }

OneSignalExample/Assets/OneSignal/src/OneSignalAndroid.cs

@@ -49,6 +49,11 @@ public interface OneSignalPlatform {
 
    void SetInFocusDisplaying(OneSignal.OSInFocusDisplayOption display);
 
+   void UserDidProvideConsent(bool consent);
+   bool UserProvidedConsent();
+   void SetRequiresUserPrivacyConsent(bool required);
+
+
    void addPermissionObserver();
    void removePermissionObserver();
    void addSubscriptionObserver();