Skip to content

Commit f5e9056

Browse files
emawbyemawby
committed
Update MIGRATION_GUIDE.md for new privacy consent names
1 parent 6e58fa0 commit f5e9056

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

‎MIGRATION_GUIDE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -244,8 +244,8 @@ The SDK is still accessible via a `OneSignal` static class, it provides access t
244244

245245
| **Kotlin** | **Java** | **Description** |
246246
| ----------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
247-
| `var requiresPrivacyConsent: Boolean` | `boolean getRequiresPrivacyConsent()`<br>`void setRequiresPrivacyConsent(boolean value)` | *Determines whether a user must consent to privacy prior to their user data being sent up to OneSignal. This should be set to `true` prior to the invocation of [initWithContext] to ensure compliance.* |
248-
| `var privacyConsent: Boolean` | `boolean getPrivacyConsent()`<br>`void setPrivacyConsent(boolean value)` | *Indicates whether privacy consent has been granted. This field is only relevant when the application has opted into data privacy protections. See [requiresPrivacyConsent].* |
247+
| `var consentRequired: Boolean` | `boolean getConsentRequired()`<br>`void setConsentRequired(boolean value)` | *Determines whether a user must consent to privacy prior to their user data being sent up to OneSignal. This should be set to `true` prior to the invocation of [initWithContext] to ensure compliance.* |
248+
| `var consentGiven: Boolean` | `boolean getConsentGiven()`<br>`void setConsentGiven(boolean value)` | *Indicates whether privacy consent has been granted. This field is only relevant when the application has opted into data privacy protections. See [consentRequired].* |
249249
| `fun initWithContext(context: Context, appId: String)` | `void initWithContext(Context context, String appId)` | *Initialize the OneSignal SDK. This should be called during startup of the application.* |
250250
| `fun login(externalId: String, jwtBearerToken: String? = null)` | `void login(String externalId, Continuation<? super Unit> completion)`<br>`void login(String externalId, String jwtBearerToken, Continuation<? super Unit> completion)` | *Login to OneSignal under the user identified by the [externalId] provided. The act of logging a user into the OneSignal SDK will switch the [user] context to that specific user.*<br><br>- *If the [externalId] exists the user will be retrieved and the context set from that user information. If operations have already been performed under a guest user, they* ***will not*** *be applied to the now logged in user (they will be lost).*<br>- *If the [externalId] does not exist the user will be created and the context set from the current local state. If operations have already been performed under a guest user those operations* ***will*** *be applied to the newly created user.*<br><br>***Push Notifications and In App Messaging***<br>*Logging in a new user will automatically transfer push notification and in app messaging subscriptions from the current user (if there is one) to the newly logged in user. This is because both Push and IAM are owned by the device.* |
251251
| `fun logout()` | `void logout(Continuation<? super Unit> completion)` | *Logout the user previously logged in via [login]. The [user] property now references a new device-scoped user. A device-scoped user has no user identity that can later be retrieved, except through this device as long as the app remains installed and the app data is not cleared.* |

0 commit comments

Comments
 (0)