Android Scanbot SDK API reference/io.scanbot.sdk.ui_v2.documentdataextractor.configuration/DocumentDataExtractorScreenConfiguration

DocumentDataExtractorScreenConfiguration

data class DocumentDataExtractorScreenConfiguration(val version: String = "1.0", val screen: String = "DocumentDataExtractor", var localization: DocumentDataExtractorScreenTextLocalization = DocumentDataExtractorScreenTextLocalization( ), var palette: Palette = Palette( ), var backgroundColor: ScanbotColor = ScanbotColor("?sbColorSurfaceLow", isArgb = false), var cameraConfiguration: CameraConfiguration = CameraConfiguration( orientationLockMode = OrientationLockMode.PORTRAIT ), var cameraPermission: CameraPermissionScreen = CameraPermissionScreen( statusBarMode = StatusBarMode.DARK, background = ScanbotColor("?sbColorSurface", isArgb = false), iconBackground = ScanbotColor("?sbColorOutline", isArgb = false), icon = IconStyle( visible = true, color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), enableCameraButton = ButtonConfiguration( visible = true, text = "?cameraPermissionEnableCameraButton", accessibilityDescription = "?accessibilityDescriptionCameraPermissionEnableCameraButton", background = BackgroundStyle( strokeColor = ScanbotColor("?sbColorPrimary", isArgb = false), fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorOnPrimary", isArgb = false), useShadow = false ) ), closeButton = ButtonConfiguration( visible = true, text = "?cameraPermissionCloseButton", accessibilityDescription = "?accessibilityDescriptionCameraPermissionCloseButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorPrimary", isArgb = false), useShadow = false ) ), enableCameraTitle = StyledText( text = "?cameraPermissionEnableCameraTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), enableCameraExplanation = StyledText( text = "?cameraPermissionEnableCameraExplanation", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ) ), var topUserGuidance: UserGuidanceConfiguration = UserGuidanceConfiguration( title = StyledText( text = "?topUserGuidance" ) ), var scanStatusUserGuidance: DocumentDataExtractorGuidanceConfiguration = DocumentDataExtractorGuidanceConfiguration( ), var topBar: TopBarConfiguration = TopBarConfiguration( title = StyledText( visible = true, text = "?topBarTitle" ), cancelButton = ButtonConfiguration( text = "?topBarCancelButton", accessibilityDescription = "?accessibilityDescriptionCancelButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ) ), var topBarOpenIntroScreenButton: IconButton = IconButton( color = ScanbotColor("?sbColorOnPrimary", isArgb = false), accessibilityDescription = "?accessibilityDescriptionOpenIntroScreenButton" ), var introScreen: DocumentDataExtractorIntroScreenConfiguration = DocumentDataExtractorIntroScreenConfiguration( ), var actionBar: ActionBarConfiguration = ActionBarConfiguration( flipCameraButton = RoundButton( visible = false, accessibilityDescription = "?accessibilityDescriptionFlipCameraButton", backgroundColor = ScanbotColor("?sbColorSurfaceHigh", isArgb = false), foregroundColor = ScanbotColor("?sbColorOnPrimary", isArgb = false), activeBackgroundColor = ScanbotColor("?sbColorWarning", isArgb = false), activeForegroundColor = ScanbotColor("#1C1B1F", isArgb = false) ) ), var viewFinder: PermanentViewFinderConfiguration = PermanentViewFinderConfiguration( style = FinderCorneredStyle( strokeColor = ScanbotColor("?sbColorSurface", isArgb = false), strokeWidth = 2.0 ), aspectRatio = AspectRatio( width = 3.0, height = 2.0 ), minimumInsets = EdgeInsets( top = 24.0, left = 24.0, bottom = 24.0, right = 24.0 ) ), var scannerConfiguration: DocumentDataExtractorConfiguration = DocumentDataExtractorConfiguration( ), var extractionProgress: DocumentDataExtractionProgressConfiguration = DocumentDataExtractionProgressConfiguration( ), var noDocumentFoundTimeout: Int = 5000, var accumulationTimeout: Int = 3000, var successOverlay: ScanCompletionOverlay = ScanCompletionOverlay( ), var noDocumentDetectedAlertDialog: ScanbotAlertDialog = ScanbotAlertDialog( title = StyledText( text = "?documentDataExtractorNoDocumentDetectedAlertTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitle = StyledText( text = "?documentDataExtractorNoDocumentDetectedAlertSubtitle", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), sheetColor = ScanbotColor("?sbColorSurface", isArgb = false), modalOverlayColor = ScanbotColor("?sbColorModalOverlay", isArgb = false), dividerColor = ScanbotColor("?sbColorOutline", isArgb = false), okButton = ButtonConfiguration( visible = true, text = "?documentDataExtractorAlertRetryButton", accessibilityDescription = "?accessibilityDescriptionRetryButton", background = BackgroundStyle( strokeColor = ScanbotColor("?sbColorPrimary", isArgb = false), fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 1.0 ), foreground = ForegroundStyle( iconVisible = true, color = ScanbotColor("?sbColorOnPrimary", isArgb = false), useShadow = false ) ), cancelButton = ButtonConfiguration( visible = true, text = "?documentDataExtractorAlertCloseScannerButton", accessibilityDescription = "?accessibilityDescriptionCloseScannerButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 1.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorPrimary", isArgb = false), useShadow = false ) ) ), var cantProcessDocumentAlertDialog: ScanbotAlertDialog = ScanbotAlertDialog( title = StyledText( text = "?documentDataExtractorCantProcessDocumentAlertTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitle = StyledText( text = "?documentDataExtractorCantProcessDocumentAlertSubtitle", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), sheetColor = ScanbotColor("?sbColorSurface", isArgb = false), modalOverlayColor = ScanbotColor("?sbColorModalOverlay", isArgb = false), dividerColor = ScanbotColor("?sbColorOutline", isArgb = false), okButton = ButtonConfiguration( visible = true, text = "?documentDataExtractorAlertRetryButton", accessibilityDescription = "?accessibilityDescriptionRetryButton", background = BackgroundStyle( strokeColor = ScanbotColor("?sbColorPrimary", isArgb = false), fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 1.0 ), foreground = ForegroundStyle( iconVisible = true, color = ScanbotColor("?sbColorOnPrimary", isArgb = false), useShadow = false ) ), cancelButton = ButtonConfiguration( visible = true, text = "?documentDataExtractorAlertCloseScannerButton", accessibilityDescription = "?accessibilityDescriptionCloseScannerButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 1.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorPrimary", isArgb = false), useShadow = false ) ) ), var unsupportedDocumentAlertDialog: ScanbotAlertDialog = ScanbotAlertDialog( title = StyledText( text = "?documentDataExtractorUnsupportedDocumentAlertTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitle = StyledText( text = "?documentDataExtractorUnsupportedDocumentAlertSubtitle", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), sheetColor = ScanbotColor("?sbColorSurface", isArgb = false), modalOverlayColor = ScanbotColor("?sbColorModalOverlay", isArgb = false), dividerColor = ScanbotColor("?sbColorOutline", isArgb = false), okButton = ButtonConfiguration( visible = true, text = "?documentDataExtractorAlertRetryButton", accessibilityDescription = "?accessibilityDescriptionRetryButton", background = BackgroundStyle( strokeColor = ScanbotColor("?sbColorPrimary", isArgb = false), fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 1.0 ), foreground = ForegroundStyle( iconVisible = true, color = ScanbotColor("?sbColorOnPrimary", isArgb = false), useShadow = false ) ), cancelButton = ButtonConfiguration( visible = true, text = "?documentDataExtractorAlertCloseScannerButton", accessibilityDescription = "?accessibilityDescriptionCloseScannerButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 1.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorPrimary", isArgb = false), useShadow = false ) ) ), var scanningTooLongAlertDialog: ScanbotAlertDialog = ScanbotAlertDialog( title = StyledText( text = "?documentDataExtractorScanningTooLongAlertTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitle = StyledText( text = "?documentDataExtractorScanningTooLongAlertSubtitle", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), sheetColor = ScanbotColor("?sbColorSurface", isArgb = false), modalOverlayColor = ScanbotColor("?sbColorModalOverlay", isArgb = false), dividerColor = ScanbotColor("?sbColorOutline", isArgb = false), okButton = ButtonConfiguration( visible = true, text = "?documentDataExtractorAlertRetryButton", accessibilityDescription = "?accessibilityDescriptionRetButton", background = BackgroundStyle( strokeColor = ScanbotColor("?sbColorPrimary", isArgb = false), fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 1.0 ), foreground = ForegroundStyle( iconVisible = true, color = ScanbotColor("?sbColorOnPrimary", isArgb = false), useShadow = false ) ), cancelButton = ButtonConfiguration( visible = true, text = "?documentDataExtractorAlertCloseScannerButton", accessibilityDescription = "?accessibilityDescriptionCloseScannerButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 1.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorPrimary", isArgb = false), useShadow = false ) ) ), var sound: Sound = Sound( ), var vibration: Vibration = Vibration( ), var keepScreenOn: Boolean = true) : Parcelable

Configuration of the screen for extracting data from ID documents.

Constructors

Link copied to clipboard
constructor(source: Map<String, Any?>)
constructor(json: JSONObject)
constructor(version: String = "1.0", screen: String = "DocumentDataExtractor", localization: DocumentDataExtractorScreenTextLocalization = DocumentDataExtractorScreenTextLocalization( ), palette: Palette = Palette( ), backgroundColor: ScanbotColor = ScanbotColor("?sbColorSurfaceLow", isArgb = false), cameraConfiguration: CameraConfiguration = CameraConfiguration( orientationLockMode = OrientationLockMode.PORTRAIT ), cameraPermission: CameraPermissionScreen = CameraPermissionScreen( statusBarMode = StatusBarMode.DARK, background = ScanbotColor("?sbColorSurface", isArgb = false), iconBackground = ScanbotColor("?sbColorOutline", isArgb = false), icon = IconStyle( visible = true, color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), enableCameraButton = ButtonConfiguration( visible = true, text = "?cameraPermissionEnableCameraButton", accessibilityDescription = "?accessibilityDescriptionCameraPermissionEnableCameraButton", background = BackgroundStyle( strokeColor = ScanbotColor("?sbColorPrimary", isArgb = false), fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorOnPrimary", isArgb = false), useShadow = false ) ), closeButton = ButtonConfiguration( visible = true, text = "?cameraPermissionCloseButton", accessibilityDescription = "?accessibilityDescriptionCameraPermissionCloseButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorPrimary", isArgb = false), useShadow = false ) ), enableCameraTitle = StyledText( text = "?cameraPermissionEnableCameraTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), enableCameraExplanation = StyledText( text = "?cameraPermissionEnableCameraExplanation", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ) ), topUserGuidance: UserGuidanceConfiguration = UserGuidanceConfiguration( title = StyledText( text = "?topUserGuidance" ) ), scanStatusUserGuidance: DocumentDataExtractorGuidanceConfiguration = DocumentDataExtractorGuidanceConfiguration( ), topBar: TopBarConfiguration = TopBarConfiguration( title = StyledText( visible = true, text = "?topBarTitle" ), cancelButton = ButtonConfiguration( text = "?topBarCancelButton", accessibilityDescription = "?accessibilityDescriptionCancelButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ) ), topBarOpenIntroScreenButton: IconButton = IconButton( color = ScanbotColor("?sbColorOnPrimary", isArgb = false), accessibilityDescription = "?accessibilityDescriptionOpenIntroScreenButton" ), introScreen: DocumentDataExtractorIntroScreenConfiguration = DocumentDataExtractorIntroScreenConfiguration( ), actionBar: ActionBarConfiguration = ActionBarConfiguration( flipCameraButton = RoundButton( visible = false, accessibilityDescription = "?accessibilityDescriptionFlipCameraButton", backgroundColor = ScanbotColor("?sbColorSurfaceHigh", isArgb = false), foregroundColor = ScanbotColor("?sbColorOnPrimary", isArgb = false), activeBackgroundColor = ScanbotColor("?sbColorWarning", isArgb = false), activeForegroundColor = ScanbotColor("#1C1B1F", isArgb = false) ) ), viewFinder: PermanentViewFinderConfiguration = PermanentViewFinderConfiguration( style = FinderCorneredStyle( strokeColor = ScanbotColor("?sbColorSurface", isArgb = false), strokeWidth = 2.0 ), aspectRatio = AspectRatio( width = 3.0, height = 2.0 ), minimumInsets = EdgeInsets( top = 24.0, left = 24.0, bottom = 24.0, right = 24.0 ) ), scannerConfiguration: DocumentDataExtractorConfiguration = DocumentDataExtractorConfiguration( ), extractionProgress: DocumentDataExtractionProgressConfiguration = DocumentDataExtractionProgressConfiguration( ), noDocumentFoundTimeout: Int = 5000, accumulationTimeout: Int = 3000, successOverlay: ScanCompletionOverlay = ScanCompletionOverlay( ), noDocumentDetectedAlertDialog: ScanbotAlertDialog = ScanbotAlertDialog( title = StyledText( text = "?documentDataExtractorNoDocumentDetectedAlertTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitle = StyledText( text = "?documentDataExtractorNoDocumentDetectedAlertSubtitle", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), sheetColor = ScanbotColor("?sbColorSurface", isArgb = false), modalOverlayColor = ScanbotColor("?sbColorModalOverlay", isArgb = false), dividerColor = ScanbotColor("?sbColorOutline", isArgb = false), okButton = ButtonConfiguration( visible = true, text = "?documentDataExtractorAlertRetryButton", accessibilityDescription = "?accessibilityDescriptionRetryButton", background = BackgroundStyle( strokeColor = ScanbotColor("?sbColorPrimary", isArgb = false), fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 1.0 ), foreground = ForegroundStyle( iconVisible = true, color = ScanbotColor("?sbColorOnPrimary", isArgb = false), useShadow = false ) ), cancelButton = ButtonConfiguration( visible = true, text = "?documentDataExtractorAlertCloseScannerButton", accessibilityDescription = "?accessibilityDescriptionCloseScannerButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 1.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorPrimary", isArgb = false), useShadow = false ) ) ), cantProcessDocumentAlertDialog: ScanbotAlertDialog = ScanbotAlertDialog( title = StyledText( text = "?documentDataExtractorCantProcessDocumentAlertTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitle = StyledText( text = "?documentDataExtractorCantProcessDocumentAlertSubtitle", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), sheetColor = ScanbotColor("?sbColorSurface", isArgb = false), modalOverlayColor = ScanbotColor("?sbColorModalOverlay", isArgb = false), dividerColor = ScanbotColor("?sbColorOutline", isArgb = false), okButton = ButtonConfiguration( visible = true, text = "?documentDataExtractorAlertRetryButton", accessibilityDescription = "?accessibilityDescriptionRetryButton", background = BackgroundStyle( strokeColor = ScanbotColor("?sbColorPrimary", isArgb = false), fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 1.0 ), foreground = ForegroundStyle( iconVisible = true, color = ScanbotColor("?sbColorOnPrimary", isArgb = false), useShadow = false ) ), cancelButton = ButtonConfiguration( visible = true, text = "?documentDataExtractorAlertCloseScannerButton", accessibilityDescription = "?accessibilityDescriptionCloseScannerButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 1.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorPrimary", isArgb = false), useShadow = false ) ) ), unsupportedDocumentAlertDialog: ScanbotAlertDialog = ScanbotAlertDialog( title = StyledText( text = "?documentDataExtractorUnsupportedDocumentAlertTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitle = StyledText( text = "?documentDataExtractorUnsupportedDocumentAlertSubtitle", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), sheetColor = ScanbotColor("?sbColorSurface", isArgb = false), modalOverlayColor = ScanbotColor("?sbColorModalOverlay", isArgb = false), dividerColor = ScanbotColor("?sbColorOutline", isArgb = false), okButton = ButtonConfiguration( visible = true, text = "?documentDataExtractorAlertRetryButton", accessibilityDescription = "?accessibilityDescriptionRetryButton", background = BackgroundStyle( strokeColor = ScanbotColor("?sbColorPrimary", isArgb = false), fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 1.0 ), foreground = ForegroundStyle( iconVisible = true, color = ScanbotColor("?sbColorOnPrimary", isArgb = false), useShadow = false ) ), cancelButton = ButtonConfiguration( visible = true, text = "?documentDataExtractorAlertCloseScannerButton", accessibilityDescription = "?accessibilityDescriptionCloseScannerButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 1.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorPrimary", isArgb = false), useShadow = false ) ) ), scanningTooLongAlertDialog: ScanbotAlertDialog = ScanbotAlertDialog( title = StyledText( text = "?documentDataExtractorScanningTooLongAlertTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitle = StyledText( text = "?documentDataExtractorScanningTooLongAlertSubtitle", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), sheetColor = ScanbotColor("?sbColorSurface", isArgb = false), modalOverlayColor = ScanbotColor("?sbColorModalOverlay", isArgb = false), dividerColor = ScanbotColor("?sbColorOutline", isArgb = false), okButton = ButtonConfiguration( visible = true, text = "?documentDataExtractorAlertRetryButton", accessibilityDescription = "?accessibilityDescriptionRetButton", background = BackgroundStyle( strokeColor = ScanbotColor("?sbColorPrimary", isArgb = false), fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 1.0 ), foreground = ForegroundStyle( iconVisible = true, color = ScanbotColor("?sbColorOnPrimary", isArgb = false), useShadow = false ) ), cancelButton = ButtonConfiguration( visible = true, text = "?documentDataExtractorAlertCloseScannerButton", accessibilityDescription = "?accessibilityDescriptionCloseScannerButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 1.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorPrimary", isArgb = false), useShadow = false ) ) ), sound: Sound = Sound( ), vibration: Vibration = Vibration( ), keepScreenOn: Boolean = true)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
var accumulationTimeout: Int

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

Link copied to clipboard
var actionBar: ActionBarConfiguration

Configuration of the action bar.

Link copied to clipboard
var backgroundColor: ScanbotColor

The background color of the document data extractor screen.

Link copied to clipboard
var cameraConfiguration: CameraConfiguration

Configuration of the camera behavior.

Link copied to clipboard
var cameraPermission: CameraPermissionScreen

Configuration of the dialog for requesting camera permissions.

Link copied to clipboard
var 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.

Link copied to clipboard
var extractionProgress: DocumentDataExtractionProgressConfiguration

Configuration of visualization of the scanning progress.

Link copied to clipboard
var introScreen: DocumentDataExtractorIntroScreenConfiguration

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

Link copied to clipboard
var keepScreenOn: Boolean

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

Link copied to clipboard
var localization: DocumentDataExtractorScreenTextLocalization

Configuration of the all strings for document data extractor screen.

Link copied to clipboard
var noDocumentDetectedAlertDialog: ScanbotAlertDialog

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

Link copied to clipboard
var 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.

Link copied to clipboard
var palette: Palette

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

Link copied to clipboard
var scannerConfiguration: DocumentDataExtractorConfiguration

Configuration of the scanner.

Link copied to clipboard
var scanningTooLongAlertDialog: ScanbotAlertDialog

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

Link copied to clipboard
var scanStatusUserGuidance: DocumentDataExtractorGuidanceConfiguration

Configuration of the extracting status.

Link copied to clipboard
val screen: String

The configuration object should be applied for this screen.

Link copied to clipboard
var sound: Sound

Configuration of the scan confirmation sound.

Link copied to clipboard
var successOverlay: ScanCompletionOverlay

Configuration of the result overlay.

Link copied to clipboard
var topBar: TopBarConfiguration

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

Link copied to clipboard
var topBarOpenIntroScreenButton: IconButton

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

Link copied to clipboard
var topUserGuidance: UserGuidanceConfiguration

Configuration of the top user guidance.

Link copied to clipboard
var unsupportedDocumentAlertDialog: ScanbotAlertDialog

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

Link copied to clipboard
val version: String

Version number of the configuration object.

Link copied to clipboard
var vibration: Vibration

Configuration of the vibration feedback.

Link copied to clipboard
var viewFinder: PermanentViewFinderConfiguration

Configuration of the view finder.

Functions

Link copied to clipboard
Link copied to clipboard
fun toJson(config: ToJsonConfiguration = ToJsonConfiguration.default()): JSONObject