Configuration of the screen for extracting data from ID documents.

Hierarchy (view full)

Constructors

Properties

accumulationTimeout: number

Timeout for the accumulation state. If the accumulation state is active longer than this value, the alert will be presented.

Default is 3000

Configuration of the action bar.

backgroundColor: string

The background color of the document data extractor screen.

Default is "?sbColorSurfaceLow"

cameraConfiguration: CameraConfiguration

Configuration of the camera behavior.

cameraPermission: CameraPermissionScreen

Configuration of the dialog for requesting camera permissions.

cantProcessDocumentAlertDialog: ScanbotAlertDialog

Configuration of the alert dialog that will be presented when the document is recognised but not presented in the list of enabled for scanning.

Configuration of visualization of the scanning progress.

Configuration of the introduction screen for the document data extractor screen.

keepScreenOn: boolean

If enabled, the screen will not turn off while the document data extractor is active. (Android only).

Default is true

Configuration of the all strings for document data extractor screen.

noDocumentDetectedAlertDialog: ScanbotAlertDialog

Configuration of the alert dialog that will be presented when no document is detected.

noDocumentFoundTimeout: number

Timeout for the no document found state. If the no document found state is active longer than this value, the alert will be presented.

Default is 5000

palette: Palette

Define the screen's base color values from which other colors are derived.

Configuration of the extracting status.

Configuration of the scanner.

scanningTooLongAlertDialog: ScanbotAlertDialog

Configuration of the alert dialog that will be presented when initial timeout for scanning document is overreached.

screen: string

The configuration object should be applied for this screen.

Default is "DocumentDataExtractor"

sound: Sound

Configuration of the scan confirmation sound.

successOverlay: ScanCompletionOverlay

Configuration of the result overlay.

Configuration of the top bar on the document data extractor screen.

topBarOpenIntroScreenButton: IconButton

Configuration of the button in the top bar that opens the introduction screen.

topUserGuidance: UserGuidanceConfiguration

Configuration of the top user guidance.

unsupportedDocumentAlertDialog: ScanbotAlertDialog

Configuration of the alert dialog that will be presented when document is not detected as one that is supported by the SDK.

version: string

Version number of the configuration object.

Default is "1.0"

vibration: Vibration

Configuration of the vibration feedback.

Configuration of the view finder.