getOptOutStatus()

From Engineering Client Portal

The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

Engineering Portal breadcrumbArrow.png Digital breadcrumbArrow.png Android SDK API Reference breadcrumbArrow.png getOptOutStatus()

This API gets the current Nielsen opt-out state of AppSDK. Call this API to retrieve the Opt-Out or Opt-In state.

Warning: calling getOptOutStatus() in main thread may cause deadlock, be sure to call in a background thread.

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.