userOptOut()

Engineering Portal Digital Android SDK API Reference userOptOut()
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.