DocumentScanningFlow class
Configuration of the document scanner screen.
Constructors
- DocumentScanningFlow({String version = "1.0", String screen = "DocumentScanner", Palette? palette, DocumentScannerTextLocalization? localization, DocumentFlowAppearanceConfiguration? appearance, DocumentScannerOutputSettings? outputSettings, DocumentScannerScreens? screens, String? documentUuid = null, bool cleanScanningSession = true, bool showReviewScreenOnStart = false, bool keepScreenOn = true})
-
DocumentScanningFlow.fromJson(Map<
String, dynamic> json) -
factory
Properties
- appearance ↔ DocumentFlowAppearanceConfiguration
-
Configuration of the general appearance.
getter/setter pair
- cleanScanningSession ↔ bool
-
Clean the existing pages from the scanning session.
getter/setter pair
- documentUuid ↔ String?
-
The UUID of the existing document to be edited.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- keepScreenOn ↔ bool
-
If enabled, the screen will not turn off while the barcode scanner is active. (Android only).
getter/setter pair
- localization ↔ DocumentScannerTextLocalization
-
Configuration of all the strings for the document scanner screen.
getter/setter pair
- outputSettings ↔ DocumentScannerOutputSettings
-
Configuration of the output settings.
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
- screen ↔ String
-
The configuration object should be applied for this screen.
getter/setter pair
- screens ↔ DocumentScannerScreens
-
Configuration of the document scanner sub-screens.
getter/setter pair
- showReviewScreenOnStart ↔ bool
-
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.
getter/setter pair
- version ↔ String
-
Version number of the configuration object.
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