Configuration of the document scanner screen.

Hierarchy (view full)

Constructors

Properties

Configuration of the general appearance.

cleanScanningSession: boolean

Clean the existing pages from the scanning session.

Default is true

documentUuid: null | string

The UUID of the existing document to be edited.

keepScreenOn: boolean

If enabled, the screen will not turn off while the barcode scanner is active. (Android only).

Default is true

Configuration of all the strings for the document scanner screen.

Configuration of the output settings.

palette: Palette

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

screen: string

The configuration object should be applied for this screen.

Default is "DocumentScanner"

Configuration of the document scanner sub-screens.

showReviewScreenOnStart: boolean

If enabled, the scanner automatically navigates to the review screen when the flow starts. This property is ignored if the document is empty or if the review screen is disabled.

Default is false

version: string

Version number of the configuration object.

Default is "1.0"