Android Scanbot SDK API reference/io.scanbot.sdk.ui_v2.check.configuration/CheckScannerScreenConfiguration

CheckScannerScreenConfiguration

data class CheckScannerScreenConfiguration(val version: String = "1.0", val screen: String = "CheckScanner", var localization: CheckScannerScreenTextLocalization = CheckScannerScreenTextLocalization( ), 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: CheckScannerGuidanceConfiguration = CheckScannerGuidanceConfiguration( ), 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: CheckScannerIntroScreenConfiguration = CheckScannerIntroScreenConfiguration( ), 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 = 2.14, height = 1.0 ), minimumInsets = EdgeInsets( top = 24.0, left = 24.0, bottom = 24.0, right = 24.0 ) ), var scannerConfiguration: CheckScannerConfiguration = CheckScannerConfiguration( ), var captureHighResolutionImage: Boolean = false, var exampleOverlayVisible: Boolean = true, var scanningProgress: CheckScanningProgressConfiguration = CheckScanningProgressConfiguration( ), var noCheckFoundTimeout: Int = 5000, var accumulationTimeout: Int = 3000, var successOverlay: ScanCompletionOverlay = ScanCompletionOverlay( ), var noCheckDetectedAlertDialog: ScanbotAlertDialog = ScanbotAlertDialog( title = StyledText( text = "?checkNoCheckDetectedAlertTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitle = StyledText( text = "?checkNoCheckDetectedAlertSubtitle", 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 = "?checkAlertRetryButton", 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 = "?checkAlertCloseScannerButton", 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 imageNotGoodAlertDialog: ScanbotAlertDialog = ScanbotAlertDialog( title = StyledText( text = "?checkImageNotGoodAlertTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitle = StyledText( text = "?checkImageNotGoodAlertSubtitle", 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 = "?checkAlertRetryButton", 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 = "?checkAlertCloseScannerButton", 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 detecting check data.

Constructors

Link copied to clipboard
constructor(source: Map<String, Any?>)
constructor(json: JSONObject)
constructor(version: String = "1.0", screen: String = "CheckScanner", localization: CheckScannerScreenTextLocalization = CheckScannerScreenTextLocalization( ), 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: CheckScannerGuidanceConfiguration = CheckScannerGuidanceConfiguration( ), 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: CheckScannerIntroScreenConfiguration = CheckScannerIntroScreenConfiguration( ), 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 = 2.14, height = 1.0 ), minimumInsets = EdgeInsets( top = 24.0, left = 24.0, bottom = 24.0, right = 24.0 ) ), scannerConfiguration: CheckScannerConfiguration = CheckScannerConfiguration( ), captureHighResolutionImage: Boolean = false, exampleOverlayVisible: Boolean = true, scanningProgress: CheckScanningProgressConfiguration = CheckScanningProgressConfiguration( ), noCheckFoundTimeout: Int = 5000, accumulationTimeout: Int = 3000, successOverlay: ScanCompletionOverlay = ScanCompletionOverlay( ), noCheckDetectedAlertDialog: ScanbotAlertDialog = ScanbotAlertDialog( title = StyledText( text = "?checkNoCheckDetectedAlertTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitle = StyledText( text = "?checkNoCheckDetectedAlertSubtitle", 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 = "?checkAlertRetryButton", 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 = "?checkAlertCloseScannerButton", 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 ) ) ), imageNotGoodAlertDialog: ScanbotAlertDialog = ScanbotAlertDialog( title = StyledText( text = "?checkImageNotGoodAlertTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitle = StyledText( text = "?checkImageNotGoodAlertSubtitle", 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 = "?checkAlertRetryButton", 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 = "?checkAlertCloseScannerButton", 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 check scanner 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 captureHighResolutionImage: Boolean

Flag to capture high resolution image.

Link copied to clipboard
var exampleOverlayVisible: Boolean

Flag to show or hide the preset button.

Link copied to clipboard
var imageNotGoodAlertDialog: ScanbotAlertDialog

Configuration of the alert dialog that will be presented when scanned image is not good.

Link copied to clipboard
var introScreen: CheckScannerIntroScreenConfiguration

Configuration of the introduction screen for the check scanner.

Link copied to clipboard
var keepScreenOn: Boolean

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

Link copied to clipboard
var localization: CheckScannerScreenTextLocalization

Configuration of the all strings for check scanner screen.

Link copied to clipboard
var noCheckDetectedAlertDialog: ScanbotAlertDialog

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

Link copied to clipboard
var noCheckFoundTimeout: Int

Timeout for the no Check found state. If the no Check 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: CheckScannerConfiguration

Configuration for the check recognizer.

Link copied to clipboard
var scanningProgress: CheckScanningProgressConfiguration

Configuration of visualization of the scanning progress.

Link copied to clipboard
var scanStatusUserGuidance: CheckScannerGuidanceConfiguration

Configuration of the user guidance below finder view.

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 success overlay.

Link copied to clipboard
var topBar: TopBarConfiguration

Configuration of the top bar on the check scanner 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
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