Document
data class DocumentScanningFlow(var version: String = "1.0", var screen: String = "DocumentScanner", var palette: Palette = Palette( sbColorPrimary = ScanbotColor("#C8193C", isArgb = false), sbColorPrimaryDisabled = ScanbotColor("#F5F5F5", isArgb = false), sbColorNegative = ScanbotColor("#FF3737", isArgb = false), sbColorPositive = ScanbotColor("#4EFFB4", isArgb = false), sbColorWarning = ScanbotColor("#FFCE5C", isArgb = false), sbColorSecondary = ScanbotColor("#FFEDEE", isArgb = false), sbColorSecondaryDisabled = ScanbotColor("#F5F5F5", isArgb = false), sbColorOnPrimary = ScanbotColor("#FFFFFF", isArgb = false), sbColorOnSecondary = ScanbotColor("#C8193C", isArgb = false), sbColorSurface = ScanbotColor("#FFFFFF", isArgb = false), sbColorOutline = ScanbotColor("#EFEFEF", isArgb = false), sbColorOnSurfaceVariant = ScanbotColor("#707070", isArgb = false), sbColorOnSurface = ScanbotColor("#000000", isArgb = false), sbColorSurfaceLow = ScanbotColor("#00000026", isArgb = false), sbColorSurfaceHigh = ScanbotColor("#0000007A", isArgb = false), sbColorModalOverlay = ScanbotColor("#000000A3", isArgb = false) ), var localization: DocumentScannerTextLocalization = DocumentScannerTextLocalization( ), var appearance: DocumentFlowAppearanceConfiguration = DocumentFlowAppearanceConfiguration( ), var outputSettings: DocumentScannerOutputSettings = DocumentScannerOutputSettings( ), var screens: DocumentScannerScreens = DocumentScannerScreens( ), var documentUuid: String? = null, var cleanScanningSession: Boolean = true, var showReviewScreenOnStart: Boolean = false, var keepScreenOn: Boolean = true) : Parcelable
Configuration of the document scanner screen.
Constructors
Link copied to clipboard
constructor(version: String = "1.0", screen: String = "DocumentScanner", palette: Palette = Palette( sbColorPrimary = ScanbotColor("#C8193C", isArgb = false), sbColorPrimaryDisabled = ScanbotColor("#F5F5F5", isArgb = false), sbColorNegative = ScanbotColor("#FF3737", isArgb = false), sbColorPositive = ScanbotColor("#4EFFB4", isArgb = false), sbColorWarning = ScanbotColor("#FFCE5C", isArgb = false), sbColorSecondary = ScanbotColor("#FFEDEE", isArgb = false), sbColorSecondaryDisabled = ScanbotColor("#F5F5F5", isArgb = false), sbColorOnPrimary = ScanbotColor("#FFFFFF", isArgb = false), sbColorOnSecondary = ScanbotColor("#C8193C", isArgb = false), sbColorSurface = ScanbotColor("#FFFFFF", isArgb = false), sbColorOutline = ScanbotColor("#EFEFEF", isArgb = false), sbColorOnSurfaceVariant = ScanbotColor("#707070", isArgb = false), sbColorOnSurface = ScanbotColor("#000000", isArgb = false), sbColorSurfaceLow = ScanbotColor("#00000026", isArgb = false), sbColorSurfaceHigh = ScanbotColor("#0000007A", isArgb = false), sbColorModalOverlay = ScanbotColor("#000000A3", isArgb = false) ), localization: DocumentScannerTextLocalization = DocumentScannerTextLocalization( ), appearance: DocumentFlowAppearanceConfiguration = DocumentFlowAppearanceConfiguration( ), outputSettings: DocumentScannerOutputSettings = DocumentScannerOutputSettings( ), screens: DocumentScannerScreens = DocumentScannerScreens( ), documentUuid: String? = null, cleanScanningSession: Boolean = true, showReviewScreenOnStart: Boolean = false, keepScreenOn: Boolean = true)
Properties
Link copied to clipboard
Configuration of the general appearance.
Link copied to clipboard
Clean the existing pages from the scanning session.
Link copied to clipboard
The UUID of the existing document to be edited.
Link copied to clipboard
If enabled, the screen will not turn off while the barcode scanner is active. (Android only).
Link copied to clipboard
Configuration of all the strings for the document scanner screen.
Link copied to clipboard
Configuration of the output settings.
Link copied to clipboard
Configuration of the document scanner sub-screens.
Link copied to clipboard
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.