FacePingOptions class

How FacePing runs in this app. Set sandboxKey or deviceToken, not both.

Annotations

• @immutable

Constructors

FacePingOptions({String? sandboxKey, String? deviceToken, FacePingRegion region = FacePingRegion.eu, String? apiBaseUrl, bool passiveLiveness = true, Duration? autoSyncInterval = const Duration(minutes: 5)})

Creates options. The native SDK checks them in FacePing.initWithOptions.

const

Properties

apiBaseUrl → String?

Overrides the region's API address, for example for the UK or US region.

final

autoSyncInterval → Duration?

Production: how often the device syncs while the app runs. Null turns it off; then call FacePing.sync yourself.

final

deviceToken → String?

Production: a fpd_ device token for one check-in list. Faces sync from your account.

final

hashCode → int

The hash code for this object.

no setter, override

isSandbox → bool

True with a sandbox key: faces are enrolled and kept on this device.

no setter

passiveLiveness → bool

Passive liveness on every check (default on). Turn it off only if your app runs its own liveness check first.

final

region → FacePingRegion

Your account's region (sets the API address).

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

sandboxKey → String?

Sandbox: a fp_test_ key from Developers, Sandbox keys. Faces are enrolled and kept on the device.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

override

Operators

operator ==(Object other) → bool

The equality operator.

override