DocumentVerificationOverlaySettings class

Class for setting up document verification overlay. Document verification overlay is best suited for multi side recognizers - recognizer that perform scanning of both sides of ID documents.

Inheritance
Annotations
  • @JsonSerializable()

Properties

country ↔ String?
(optional) to be used with language variable, it defines the country locale example: "US" to use "en_US" on Android and en-US on iOS
getter/setter pairinherited
enableBeep ↔ bool
whether beep sound will be played on successful scan false by default
getter/setter pairinherited
firstSideInstructions ↔ String?
String: user instructions that are shown above camera preview while the first side of the document is being scanned. If null, default value will be used.
getter/setter pair
firstSideSplashMessage ↔ String?
String: splash message that is shown before scanning the first side of the document, while starting camera. If null, default value will be used.
getter/setter pair
glareMessage ↔ String?
String: glare message that is shown if glare was detected while scanning document. If null, default value will be used.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
language ↔ String?
(optional) if default overlay contains textual information, text will be localized to this language. Otherwise device langauge will be used example: "en"
getter/setter pairinherited
overlaySettingsType ↔ String?
type of the overlay settings object
getter/setter pairinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scanningDoneSplashMessage ↔ String?
String: splash message that is shown after scanning the document. If null, default value will be used.
getter/setter pair
secondSideInstructions ↔ String?
String: user instructions that are shown above camera preview while the second side of the document is being scanned. If null, default value will be used.
getter/setter pair
secondSideSplashMessage ↔ String?
String: splash message that is shown before scanning the second side of the document, while starting camera. If null, default value will be used.
getter/setter pair
useFrontCamera ↔ bool
whether front camera should be used instead of the default camera false by default
getter/setter pairinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
override
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited