DocumentDataExtractorScreenConfiguration class

Configuration of the screen for extracting data from ID documents.

Constructors

DocumentDataExtractorScreenConfiguration({String version = "1.0", String screen = "DocumentDataExtractor", DocumentDataExtractorScreenTextLocalization? localization, Palette? palette, ScanbotColor? backgroundColor, CameraConfiguration? cameraConfiguration, CameraPermissionScreen? cameraPermission, UserGuidanceConfiguration? topUserGuidance, DocumentDataExtractorGuidanceConfiguration? scanStatusUserGuidance, TopBarConfiguration? topBar, ScanbotIconButton? topBarOpenIntroScreenButton, DocumentDataExtractorIntroScreenConfiguration? introScreen, ActionBarConfiguration? actionBar, PermanentViewFinderConfiguration? viewFinder, DocumentDataExtractorConfiguration? scannerConfiguration, DocumentDataExtractionProgressConfiguration? extractionProgress, int noDocumentFoundTimeout = 5000, int accumulationTimeout = 3000, ScanCompletionOverlay? successOverlay, ScanbotAlertDialog? noDocumentDetectedAlertDialog, ScanbotAlertDialog? cantProcessDocumentAlertDialog, ScanbotAlertDialog? unsupportedDocumentAlertDialog, ScanbotAlertDialog? scanningTooLongAlertDialog, Sound? sound, Vibration? vibration, bool keepScreenOn = true})
DocumentDataExtractorScreenConfiguration.fromJson(Map<String, dynamic> json)
factory

Properties

accumulationTimeout ↔ int
Timeout for the accumulation state. If the accumulation state is active longer than this value, the alert will be presented.
getter/setter pair
actionBar ↔ ActionBarConfiguration
Configuration of the action bar.
getter/setter pair
backgroundColor ↔ ScanbotColor
The background color of the document data extractor screen.
getter/setter pair
cameraConfiguration ↔ CameraConfiguration
Configuration of the camera behavior.
getter/setter pair
cameraPermission ↔ CameraPermissionScreen
Configuration of the dialog for requesting camera permissions.
getter/setter pair
cantProcessDocumentAlertDialog ↔ ScanbotAlertDialog
Configuration of the alert dialog that will be presented when no document is detected.
getter/setter pair
extractionProgress ↔ DocumentDataExtractionProgressConfiguration
Configuration of visualization of the scanning progress.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
introScreen ↔ DocumentDataExtractorIntroScreenConfiguration
Configuration of the introduction screen for the document data extractor screen.
getter/setter pair
keepScreenOn ↔ bool
If enabled, the screen will not turn off while the document data extractor is active.
getter/setter pair
localization ↔ DocumentDataExtractorScreenTextLocalization
Configuration of the all strings for document data extractor screen.
getter/setter pair
noDocumentDetectedAlertDialog ↔ ScanbotAlertDialog
Configuration of the alert dialog that will be presented when no document is detected.
getter/setter pair
noDocumentFoundTimeout ↔ int
Timeout for the no document found state. If the no document found state is active longer than this value, the alert will be presented.
getter/setter pair
palette ↔ Palette
Define the screen's base color values from which other colors are derived.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scannerConfiguration ↔ DocumentDataExtractorConfiguration
Configuration of the scanner.
getter/setter pair
scanningTooLongAlertDialog ↔ ScanbotAlertDialog
Configuration of the alert dialog that will be presented when no document is detected.
getter/setter pair
scanStatusUserGuidance ↔ DocumentDataExtractorGuidanceConfiguration
Configuration of the extracting status.
getter/setter pair
screen → String
The configuration object should be applied for this screen.
final
sound ↔ Sound
Configuration of the scan confirmation sound.
getter/setter pair
successOverlay ↔ ScanCompletionOverlay
Configuration of the result overlay.
getter/setter pair
topBar ↔ TopBarConfiguration
Configuration of the top bar on the document data extractor screen.
getter/setter pair
topBarOpenIntroScreenButton ↔ ScanbotIconButton
Configuration of the button in the top bar that opens the introduction screen.
getter/setter pair
topUserGuidance ↔ UserGuidanceConfiguration
Configuration of the top user guidance.
getter/setter pair
unsupportedDocumentAlertDialog ↔ ScanbotAlertDialog
Configuration of the alert dialog that will be presented when no document is detected.
getter/setter pair
version → String
Version number of the configuration object.
final
vibration ↔ Vibration
Configuration of the vibration feedback.
getter/setter pair
viewFinder ↔ PermanentViewFinderConfiguration
Configuration of the view finder.
getter/setter pair

Methods

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

Operators

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