LivenessConfig class

Configuration for the Liveness processing. The configuration provides convenient properties to change the behavior and the appearance of the Liveness UI module.

Constructors

LivenessConfig({bool copyright = true, bool cameraSwitchEnabled = false, bool closeButtonEnabled = true, bool torchButtonEnabled = true, bool vibrateOnSteps = true, int? cameraPositionAndroid, CameraPosition cameraPositionIOS = CameraPosition.FRONT, List<ScreenOrientation> screenOrientation = const [ScreenOrientation.PORTRAIT], bool locationTrackingEnabled = true, int attemptsCount = 0, RecordingProcess recordingProcess = RecordingProcess.ASYNCHRONOUS_UPLOAD, LivenessType livenessType = LivenessType.ACTIVE, String? tag, List<LivenessSkipStep> skipStep = const [], dynamic metadata})

Properties

attemptsCount ↔ int

The number of attempts to pass the Liveness before completing with error. Defaults to 0. When set to 0 the Liveness will always ask to retry on error.

getter/setter pair

cameraPositionAndroid ↔ int?

Android only.

getter/setter pair

cameraPositionIOS ↔ CameraPosition

IOS only.

getter/setter pair

cameraSwitchEnabled ↔ bool

Defines, whether the camera's toolbar switch camera button is available on the Liveness UI. Defaults to false. When set to true the CameraToolbarView will contain a button to change current cameraPosition. Only for livenessType = LivenessType.PASSIVE.

getter/setter pair

closeButtonEnabled ↔ bool

getter/setter pair

copyright ↔ bool

Defines, whether the logo is visible on the bottom of Liveness UI screens. Defaults to true.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

livenessType ↔ LivenessType

Defines whether the liveness processing type. Defaults to LivenessType.ACTIVE.

getter/setter pair

locationTrackingEnabled ↔ bool

Defines whether the liveness request sends a location of a device. Defaults to true. When set to true the liveness request to web service will contain the location object within the json metadata object. The location is used only when permissions are granted and the location is available.

getter/setter pair

metadata ↔ dynamic

getter/setter pair

recordingProcess ↔ RecordingProcess

Defines whether the liveness recording video of processing. Defaults to RecordingProcess.ASYNCHRONOUS_UPLOAD.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

screenOrientation ↔ List<ScreenOrientation>

Android only.

getter/setter pair

skipStep ↔ List<LivenessSkipStep>

Defines which steps of the user interface can be omitted. See LivenessSkipStep enum for details.

getter/setter pair

tag ↔ String?

Defines tag that can be used in Liveness processing. Defaults to null.

getter/setter pair

torchButtonEnabled ↔ bool

Defines, whether the camera's toolbar torch button is available on the Liveness UI. Defaults to true. When set to false the CameraToolbarView won't contain a button to toggle camera's flashlight. Only for livenessType = LivenessType.PASSIVE.

getter/setter pair

vibrateOnSteps ↔ bool

Enables vibration during Liveness processing. Defaults to true.

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

fromJson(dynamic jsonObject) → LivenessConfig?