getOptOutStatus (Browser): Difference between revisions
From Engineering Client Portal
(Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Browser SDK API Reference}} {{CurrentBreadcrumb}} Category:Digital Category:Browser SDK API Reference This API gets...") |
(No difference)
|
Latest revision as of 21:52, 21 May 2017
This API gets the current Nielsen opt-out state of AppSDK. Call this API to retrieve the Opt-Out or Opt-In state.
Syntax
public boolean getOptOutStatus()
Input Parameters
| Parameter | Description |
|---|---|
| none |
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.
The Opt-Out status is internally managed and stored by the SDK. The App does not need to retain the value of SDK Opt-Out status.