Package-level declarations
Types
Link copied to clipboard
A custom image for the introduction screen.
Link copied to clipboard
No image for the introduction screen.
Link copied to clipboard
Android native configuration for the scanner.
Link copied to clipboard
No image for the introduction screen.
Link copied to clipboard
data class CheckScannerGuidanceConfiguration(var visibility: Boolean = true, var title: StyledText = StyledText( text = "?checkUserGuidanceNoCheckFound", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), var background: BackgroundStyle = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("?sbColorSurfaceLow", isArgb = false) ), var statesTitles: CheckScannerGuidanceStates = CheckScannerGuidanceStates( )) : Parcelable
Configuration of the hints guiding users through the check scanning process.
Link copied to clipboard
data class CheckScannerGuidanceStates(var noCheckFound: String = "?checkUserGuidanceNoCheckFound", var scanningProgress: String = "?checkUserGuidanceScanningProgress", var tooDark: String = "?checkUserGuidanceTooDark", var tooSmall: String = "?checkUserGuidanceTooSmall", var badPerspective: String = "?checkUserGuidanceBadPerspective") : Parcelable
Configure the captions of the user guidance hints for different scanning states.
Link copied to clipboard
The image for the introduction screen of a check scanner screen.
Link copied to clipboard
data class CheckScannerIntroScreenConfiguration(var image: CheckScannerIntroImage = CheckIntroDefaultImage( ), var backgroundColor: ScanbotColor = ScanbotColor("?sbColorSurface", isArgb = false), var dividerColor: ScanbotColor = ScanbotColor("?sbColorOutline", isArgb = false), var handlerColor: ScanbotColor = ScanbotColor("?sbColorOutline", isArgb = false), var showAutomatically: Boolean = false, var title: StyledText = StyledText( text = "?introScreenTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), var explanation: StyledText = StyledText( text = "?introScreenText", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), var doneButton: ButtonConfiguration = ButtonConfiguration( text = "?introScreenDoneButton", accessibilityDescription = "?accessibilityDescriptionIntroScreenDoneButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) )) : Parcelable
Configuration of the introduction screen for the check scanner.
Link copied to clipboard
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.
Link copied to clipboard
data class CheckScannerScreenTextLocalization(var topBarTitle: String = "Check Scanner", var topBarCancelButton: String = "Cancel", var topUserGuidance: String = "Point the camera at the check", var finderViewUserGuidance: String = "Looking for check...", var introScreenTitle: String = "How to scan a check", var introScreenDoneButton: String = "Start Scanning", var introScreenText: String = "This scanner reads the MICR (Magnetic Ink Character Recognition) line – the numbers and characters printed at the bottom of your check.", var completionOverlaySuccessMessage: String = "Scanned successfully", var accessibilityDescriptionOpenIntroScreenButton: String = "Open Check Scanner introduction", var accessibilityDescriptionIntroScreenDoneButton: String = "Start check scanning", var accessibilityDescriptionCancelButton: String = "Cancel check scanning", var accessibilityDescriptionRetryButton: String = "Retry check scanning", var accessibilityDescriptionCloseScannerButton: String = "Close check scanner", var checkAlertRetryButton: String = "Retry", var checkAlertCloseScannerButton: String = "Close Scanner", var checkNoCheckDetectedAlertTitle: String = "No check detected", var checkNoCheckDetectedAlertSubtitle: String = "The scanner couldn't detect the check. Please ensure the check is valid, well-lit, and fully visible, then try again.", var checkImageNotGoodAlertTitle: String = "Check not recognized", var checkImageNotGoodAlertSubtitle: String = "Make sure the check is valid, well-lit, and fully visible. Then try again.", var accessibilityDescriptionFlashButton: String = "Toggle flash", var accessibilityDescriptionZoomButton: String = "Toggle camera zoom", var accessibilityDescriptionFlipCameraButton: String = "Flip camera", var cameraPermissionEnableCameraTitle: String = "Camera permission denied!", var cameraPermissionEnableCameraExplanation: String = "Please allow the usage of the camera to start the scanning process.", var cameraPermissionEnableCameraButton: String = "Grant permission", var cameraPermissionCloseButton: String = "Close", var accessibilityDescriptionCameraPermissionEnableCameraButton: String = "Tap to grant camera permission", var accessibilityDescriptionCameraPermissionCloseButton: String = "Close screen without granting permission", var checkUserGuidanceNoCheckFound: String = "Looking for check...", var checkUserGuidanceScanningProgress: String = "Scanning the check...", var checkUserGuidanceTooDark: String = "Too dark. Please turn on a light.", var checkUserGuidanceTooSmall: String = "Please move closer to the check.", var checkUserGuidanceBadPerspective: String = "Please hold your device straight over the check.") : Parcelable
Configuration of the all strings for check scanner screen.
Link copied to clipboard
data class CheckScannerUiResult(val recognitionStatus: CheckMagneticInkStripScanningStatus, val croppedImage: ImageRef?, val check: GenericDocument?) : AutoCloseable, Parcelable
Configuration of the check scanner RTU UI result.
Link copied to clipboard
data class CheckScanningProgressConfiguration(var enabled: Boolean = true, var progressColor: ScanbotColor = ScanbotColor("#40A9FF", isArgb = false), var animationDuration: Int = 1000) : Parcelable
Configuration of visualization of the scanning progress - indeterminate progress.