userOptOut(): Difference between revisions
From Engineering Client Portal
(Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Android SDK API Reference}} {{CurrentBreadcrumb}} Category:Digital Category:Android SDK API Reference This API prov...") |
(Fixing curly quotes) |
||
| Line 22: | Line 22: | ||
! Output Parameters (Return value) !! Description | ! Output Parameters (Return value) !! Description | ||
|- | |- | ||
| True / False || Returns | | True / False || Returns 'True' if App SDK is currently opted out and returns 'False' if SDK is in opt-in state. | ||
|} | |} | ||
== Notes == | == Notes == | ||
The value of the <code>userOptOut</code> state is persisted across application launches on the shared preferences object local to the App SDK. | The value of the <code>userOptOut</code> state is persisted across application launches on the shared preferences object local to the App SDK. | ||
Latest revision as of 18:17, 27 August 2018
This API provides the selection made by user in Nielsen opt-out or opt-in webview screen and pass the value to AppSDK(). Call this API when the user has elected to Opt-out or Opt-in (in the webview).
Syntax
public boolean userOptOut(String optOut)
Input Parameters
| Parameter | Description |
|---|---|
| optOut | String value received back from the Nielsen Opt-out web page. This value is set by the web page and the application is responsible for passing this value back to the SDK without modification. |
Output Parameters
| Output Parameters (Return value) | Description |
|---|---|
| True / False | Returns 'True' if App SDK is currently opted out and returns 'False' if SDK is in opt-in state. |
Notes
The value of the userOptOut state is persisted across application launches on the shared preferences object local to the App SDK.