AutocaptureOptions
public struct AutocaptureOptions
Configuration options for automatic event capture (clicks, rage clicks, dead clicks).
Autocapture is disabled by default and must be explicitly enabled by providing
AutocaptureOptions during SDK initialization.
Example - Enable with defaults:
let options = MixpanelOptions(
token: "YOUR_TOKEN",
autocaptureOptions: AutocaptureOptions()
)
Example - Custom configuration:
let autocaptureOpts = AutocaptureOptions(
clickOptions: ClickOptions(enabled: true),
rageClickOptions: RageClickOptions(
enabled: true,
clickThreshold: 5, // Require 5 clicks instead of 4
timeWindowMs: 800 // Shorter time window
),
deadClickOptions: DeadClickOptions(
enabled: false // Disable dead click detection
)
)
let options = MixpanelOptions(
token: "YOUR_TOKEN",
autocaptureOptions: autocaptureOpts
)
Platform support: iOS only. Mac Catalyst builds accept these options so shared iOS sources keep compiling, but automatic capture never starts there.
Warning
Experimental (beta). Autocapture may contain issues, and its API and the properties it captures may change in a future release before general availability. Pin your SDK version if you build reports on autocaptured events.-
Configuration for basic click capture.
Declaration
Swift
public let clickOptions: ClickOptions -
Configuration for rage click detection.
Declaration
Swift
public let rageClickOptions: RageClickOptions -
Configuration for dead click detection.
Declaration
Swift
public let deadClickOptions: DeadClickOptions -
Returns
trueif any autocapture feature is enabled.Declaration
Swift
public var isEnabled: Bool { get } -
Undocumented
Declaration
Swift
public init( clickOptions: ClickOptions = ClickOptions(), rageClickOptions: RageClickOptions = RageClickOptions(), deadClickOptions: DeadClickOptions = DeadClickOptions() )
View on GitHub