userOptOut: Difference between revisions
From Engineering Client Portal
(Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|iOS SDK API Reference}} {{CurrentBreadcrumb}} Category:Digital Category:iOS SDK API Reference This API is to be ca...") |
No edit summary |
||
| Line 24: | Line 24: | ||
|- | |- | ||
| FALSE || The command response or URL was not intended for the Nielsen SDK. Retrieve the next URL if requested. | | FALSE || The command response or URL was not intended for the Nielsen SDK. Retrieve the next URL if requested. | ||
|- | |||
| TRUE || This command was handled by the Nielsen SDK. | | TRUE || This command was handled by the Nielsen SDK. | ||
|} | |} | ||
Latest revision as of 18:18, 27 August 2018
This API is to be called when the user has elected to Opt-in or Opt-out of Nielsen measurement.
Note: The SDK will continue measurement even after the user has opted out from Nielsen measurement.
Syntax
– (BOOL) userOptOut: (NSString *) optOut;
Input Parameters
| Parameter | Description |
|---|---|
| optOut | NSString 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 |
|---|---|
| FALSE | The command response or URL was not intended for the Nielsen SDK. Retrieve the next URL if requested. |
| TRUE | This command was handled by the Nielsen SDK. |
Notes
The value of the userOptOut state is persisted across application launches or applicationWillEnterForeground mode changes.