optOutStatus

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 iOS SDK API Reference breadcrumbArrow.png optOutStatus
This API gets the current Nielsen opt-out state of AppSDK. Call this API to retrieve the Opt-Out or Opt-In state.

Note: This API is a blocking call and should not be called from main/ UI thread.

Syntax

@property (readonly) BOOL optOutStatus


Input Parameters

Parameter Description
None


Output Parameters

Return value Description
YES If the user opts out through the Opt-Out web page

OR If ‘Limit Ad Tracking’ is turned ON (though user has not opted out through Opt-Out web page)

NO If SDK is in Opt-In state

AND If the ‘Limit Ad Tracking’ is not turned ON.


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.
  • The SDK will continue measurement even after the user has opted out from Nielsen measurement.