setOptOut

The setOptOut() method sets the opt-out flag for the entire app. Once the opt-out flag is set, no data is collected.

By default, setOptOut(false) is set.

Syntax

tracker.isOptOut = isOptOut

getTracker().setOptOut(isOptOut);

Parameters

isOptOut (boolean, required)

Whether the opt-out flag is set.

• true if the flag is set
• false if the flag isn’t set

Examples

To set the opt-out flag and not collect any data:

tracker.isOptOut = true

getTracker().setOptOut(true);

Notes

• When opt-out is enabled, the SDK dispatches any pending events in the queue before stopping data collection.
• The setting is persisted across app restarts.