add consent required toggle

Author: fadi-george

Examples/OneSignalDemoV2/app/src/main/java/com/onesignal/sdktest/application/MainApplication.kt

@@ -67,6 +67,10 @@ class MainApplication : MultiDexApplication() {
         // Initialize tooltip helper
         TooltipHelper.init(this)
 
+        // Set consent required before init (must be set before initWithContext)
+        OneSignal.consentRequired = SharedPreferenceUtil.getCachedConsentRequired(this)
+        OneSignal.consentGiven = SharedPreferenceUtil.getUserPrivacyConsent(this)
+
         // Initialize OneSignal on main thread (required)
         OneSignal.initWithContext(this, appId)
         LogManager.i(TAG, "OneSignal init completed")

Examples/OneSignalDemoV2/app/src/main/java/com/onesignal/sdktest/data/repository/OneSignalRepository.kt

@@ -212,6 +212,15 @@ class OneSignalRepository {
     }
 
     // Privacy consent
+    fun setConsentRequired(required: Boolean) {
+        Log.d(TAG, "Setting consent required: $required")
+        OneSignal.consentRequired = required
+    }
+
+    fun getConsentRequired(): Boolean {
+        return OneSignal.consentRequired
+    }
+
     fun setPrivacyConsent(granted: Boolean) {
         Log.d(TAG, "Setting privacy consent: $granted")
         OneSignal.consentGiven = granted

Examples/OneSignalDemoV2/app/src/main/java/com/onesignal/sdktest/ui/main/MainScreen.kt

@@ -67,6 +67,7 @@ fun MainScreen(viewModel: MainViewModel) {
     val pushSubscriptionId by viewModel.pushSubscriptionId.observeAsState()
     val pushEnabled by viewModel.pushEnabled.observeAsState(false)
     val hasNotificationPermission by viewModel.hasNotificationPermission.observeAsState(false)
+    val consentRequired by viewModel.consentRequired.observeAsState(false)
     val privacyConsentGiven by viewModel.privacyConsentGiven.observeAsState(false)
     val externalUserId by viewModel.externalUserId.observeAsState()
     val aliases by viewModel.aliases.observeAsState(emptyList())
@@ -166,6 +167,8 @@ fun MainScreen(viewModel: MainViewModel) {
                 // === APP SECTION ===
                 AppSection(
                     appId = appId,
+                    consentRequired = consentRequired,
+                    onConsentRequiredChange = { viewModel.setConsentRequired(it) },
                     privacyConsentGiven = privacyConsentGiven,
                     onConsentChange = { viewModel.setPrivacyConsent(it) },
                     externalUserId = externalUserId,

Examples/OneSignalDemoV2/app/src/main/java/com/onesignal/sdktest/ui/main/MainViewModel.kt

@@ -38,6 +38,10 @@ class MainViewModel(application: Application) : AndroidViewModel(application), I
     private val _hasNotificationPermission = MutableLiveData<Boolean>()
     val hasNotificationPermission: LiveData<Boolean> = _hasNotificationPermission
 
+    // Consent Required
+    private val _consentRequired = MutableLiveData<Boolean>()
+    val consentRequired: LiveData<Boolean> = _consentRequired
+
     // Privacy Consent
     private val _privacyConsentGiven = MutableLiveData<Boolean>()
     val privacyConsentGiven: LiveData<Boolean> = _privacyConsentGiven
@@ -119,6 +123,7 @@ class MainViewModel(application: Application) : AndroidViewModel(application), I
         val context = getApplication<Application>()
 
         _appId.value = SharedPreferenceUtil.getOneSignalAppId(context) ?: ""
+        _consentRequired.value = repository.getConsentRequired()
         _privacyConsentGiven.value = repository.getPrivacyConsent()
         _inAppMessagesPaused.value = repository.isInAppMessagesPaused()
         _locationShared.value = repository.isLocationShared()
@@ -257,6 +262,14 @@ class MainViewModel(application: Application) : AndroidViewModel(application), I
         }
     }
 
+    // Consent required
+    fun setConsentRequired(required: Boolean) {
+        repository.setConsentRequired(required)
+        SharedPreferenceUtil.cacheConsentRequired(getApplication(), required)
+        _consentRequired.value = required
+        showToast(if (required) "Consent required enabled" else "Consent required disabled")
+    }
+
     // Privacy consent
     fun setPrivacyConsent(granted: Boolean) {
         repository.setPrivacyConsent(granted)

Examples/OneSignalDemoV2/app/src/main/java/com/onesignal/sdktest/ui/main/Sections.kt

@@ -47,6 +47,8 @@ import com.onesignal.sdktest.ui.theme.WarningBackground
 @Composable
 fun AppSection(
     appId: String,
+    consentRequired: Boolean,
+    onConsentRequiredChange: (Boolean) -> Unit,
     privacyConsentGiven: Boolean,
     onConsentChange: (Boolean) -> Unit,
     externalUserId: String?,
@@ -118,11 +120,20 @@ fun AppSection(
         elevation = CardDefaults.cardElevation(defaultElevation = 0.dp)
     ) {
         ToggleRow(
-            label = "Privacy Consent",
-            description = "Consent given for data collection",
-            checked = privacyConsentGiven,
-            onCheckedChange = onConsentChange
+            label = "Consent Required",
+            description = "Require consent before SDK processes data",
+            checked = consentRequired,
+            onCheckedChange = onConsentRequiredChange
         )
+        if (consentRequired) {
+            HorizontalDivider(modifier = Modifier.padding(horizontal = 16.dp))
+            ToggleRow(
+                label = "Privacy Consent",
+                description = "Consent given for data collection",
+                checked = privacyConsentGiven,
+                onCheckedChange = onConsentChange
+            )
+        }
     }
 
     // Logged In As (shown above buttons when logged in)

Examples/OneSignalDemoV2/app/src/main/java/com/onesignal/sdktest/util/SharedPreferenceUtil.kt

@@ -11,6 +11,7 @@ object SharedPreferenceUtil {
     private const val USER_EXTERNAL_USER_ID_SHARED_PREF = "USER_EXTERNAL_USER_ID_SHARED_PREF"
     private const val LOCATION_SHARED_PREF = "LOCATION_SHARED_PREF"
     private const val IN_APP_MESSAGING_PAUSED_PREF = "IN_APP_MESSAGING_PAUSED_PREF"
+    private const val CONSENT_REQUIRED_PREF = "CONSENT_REQUIRED_PREF"
 
     private fun getSharedPreference(context: Context): SharedPreferences {
         return context.getSharedPreferences(APP_SHARED_PREFS, Context.MODE_PRIVATE)
@@ -60,4 +61,12 @@ object SharedPreferenceUtil {
     fun cacheInAppMessagingPausedStatus(context: Context, paused: Boolean) {
         getSharedPreference(context).edit().putBoolean(IN_APP_MESSAGING_PAUSED_PREF, paused).apply()
     }
+
+    fun getCachedConsentRequired(context: Context): Boolean {
+        return getSharedPreference(context).getBoolean(CONSENT_REQUIRED_PREF, false)
+    }
+
+    fun cacheConsentRequired(context: Context, required: Boolean) {
+        getSharedPreference(context).edit().putBoolean(CONSENT_REQUIRED_PREF, required).apply()
+    }
 }

Examples/OneSignalDemoV2/build_app_prompt.md

@@ -78,6 +78,8 @@ Location:
 - promptLocation()
 
 Privacy consent:
+- setConsentRequired(required: Boolean)
+- getConsentRequired(): Boolean
 - setPrivacyConsent(granted: Boolean)
 - getPrivacyConsent(): Boolean
 
@@ -166,10 +168,16 @@ App Section layout:
    - Link text: "Get your keys at onesignal.com" (clickable, opens browser)
    - Light background color to stand out
 
-3. Privacy Consent toggle switch:
-   - Label: "Privacy Consent"
-   - Description: "Consent given for data collection"
-   - Switch control
+3. Consent card with up to two toggles:
+   a. "Consent Required" toggle (always visible):
+      - Label: "Consent Required"
+      - Description: "Require consent before SDK processes data"
+      - Sets OneSignal.consentRequired
+   b. "Privacy Consent" toggle (only visible when Consent Required is ON):
+      - Label: "Privacy Consent"
+      - Description: "Consent given for data collection"
+      - Sets OneSignal.consentGiven
+      - Separated from the above toggle by a horizontal divider
    - NOT a blocking overlay - user can interact with app regardless of state
 
 4. "Logged in as" display (ABOVE the buttons, only visible when logged in):
@@ -508,6 +516,7 @@ showTooltipDialog?.let { key ->
 ```
 SharedPreferenceUtil.kt stores:
 - OneSignal App ID
+- Consent required status
 - Privacy consent status
 - External user ID (for login state restoration)
 - Location shared status
@@ -519,12 +528,17 @@ SharedPreferenceUtil.kt stores:
 ```
 On app startup, state is restored in two layers:
 
-1. MainApplication.kt restores SDK state from SharedPreferences cache:
+1. MainApplication.kt restores SDK state from SharedPreferences cache BEFORE init:
+   - OneSignal.consentRequired = SharedPreferenceUtil.getCachedConsentRequired(context)
+   - OneSignal.consentGiven = SharedPreferenceUtil.getUserPrivacyConsent(context)
+   - OneSignal.initWithContext(this, appId)
+   Then AFTER init, restores remaining SDK state:
    - OneSignal.InAppMessages.paused = SharedPreferenceUtil.getCachedInAppMessagingPausedStatus(context)
    - OneSignal.Location.isShared = SharedPreferenceUtil.getCachedLocationSharedStatus(context)
-   This ensures the SDK has the correct state before any UI is created.
+   This ensures consent settings are in place before the SDK initializes.
 
 2. MainViewModel.loadInitialState() reads UI state from the SDK (not SharedPreferences):
+   - _consentRequired from repository.getConsentRequired() (reads OneSignal.consentRequired)
    - _privacyConsentGiven from repository.getPrivacyConsent() (reads OneSignal.consentGiven)
    - _inAppMessagesPaused from repository.isInAppMessagesPaused() (reads OneSignal.InAppMessages.paused)
    - _locationShared from repository.isLocationShared() (reads OneSignal.Location.isShared)