OpenpanelOptions class

Configuration passed to Openpanel.initialize.

Mirrors the options of the official OpenPanel mobile SDKs: cloud projects work with just a clientId, self-hosted instances additionally need an apiUrl.

Constructors

OpenpanelOptions({required String clientId, String? clientSecret, String apiUrl = defaultApiUrl, bool automaticTracking = true, bool disabled = false, bool verbose = false, String? profileId})

Creates OpenPanel configuration.

const

Properties

apiUrl → String

Base URL of the OpenPanel API.

final

automaticTracking → bool

Whether app_opened and app_closed events are tracked automatically on app lifecycle transitions.

final

clientId → String

The client ID of your OpenPanel project.

final

clientSecret → String?

The client secret of your OpenPanel project.

final

disabled → bool

Disables all collection. Events are dropped and nothing is sent.

final

hashCode → int

The hash code for this object.

no setter, inherited

profileId → String?

Initial profile binding used when the SDK has no persisted one.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

verbose → bool

Enables verbose native logging of every queued and sent event.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toMap() → Map<String, Object?>

Serializes the options for the platform channel.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Constants

defaultApiUrl → const String

Default endpoint of the OpenPanel cloud API.