Package-level declarations
Types
Link copied to clipboard
A custom image for the introduction screen.
Link copied to clipboard
The image for the introduction screen with one side of a credit card.
Link copied to clipboard
The image for the introduction screen with two sides of a credit card.
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 CreditCardScanGuidanceConfiguration(var visibility: Boolean = true, var title: StyledText = StyledText( text = "?creditCardUserGuidanceNoCardFound", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), var background: BackgroundStyle = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("?sbColorSurfaceLow", isArgb = false) ), var statesTitles: CreditCardScannerGuidanceStates = CreditCardScannerGuidanceStates( )) : Parcelable
Configuration of the hints guiding users through the credit card scanning process.
Link copied to clipboard
data class CreditCardScannerGuidanceStates(var noCardFound: String = "?creditCardUserGuidanceNoCardFound", var scanningProgress: String = "?creditCardUserGuidanceScanningProgress", var tooDark: String = "?creditCardUserGuidanceTooDark", var tooSmall: String = "?creditCardUserGuidanceTooSmall", var badPerspective: String = "?creditCardUserGuidanceBadPerspective") : 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 credit card scanner screen.
Link copied to clipboard
data class CreditCardScannerIntroScreenConfiguration(var image: CreditCardScannerIntroImage = CreditCardIntroOneSideImage( ), 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 credit card scanner.
Link copied to clipboard
data class CreditCardScannerScreenConfiguration(val version: String = "1.0", val screen: String = "CreditCardScanner", var localization: CreditCardScannerScreenTextLocalization = CreditCardScannerScreenTextLocalization( ), 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: CreditCardScanGuidanceConfiguration = CreditCardScanGuidanceConfiguration( ), 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: CreditCardScannerIntroScreenConfiguration = CreditCardScannerIntroScreenConfiguration( ), 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 = 1.586, height = 1.0 ), minimumInsets = EdgeInsets( top = 24.0, left = 24.0, bottom = 24.0, right = 24.0 ) ), var scannerConfiguration: CreditCardScannerConfiguration = CreditCardScannerConfiguration( ), var exampleOverlayVisible: Boolean = true, var scanningProgress: CreditCardScanningProgressConfiguration = CreditCardScanningProgressConfiguration( ), var scanIncompleteDataTimeout: Int = 3000, var successOverlay: ScanCompletionOverlay = ScanCompletionOverlay( ), var incompleteDataOverlay: ScanCompletionOverlay = ScanCompletionOverlay( message = StyledText( text = "?completionOverlayIncompleteDataMessage" ) ), var sound: Sound = Sound( ), var vibration: Vibration = Vibration( ), var keepScreenOn: Boolean = true) : Parcelable
Configuration of the screen for detecting credit card data.
Link copied to clipboard
data class CreditCardScannerScreenTextLocalization(var topBarTitle: String = "Credit Card Scanner", var topBarCancelButton: String = "Cancel", var topUserGuidance: String = "Scan the credit card", var introScreenTitle: String = "How to scan a credit card", var introScreenDoneButton: String = "Start Scanning", var introScreenText: String = "To quickly and securely input your credit card details, please hold your device over the credit card, so that the camera aligns with the numbers on the front of the card. ", var completionOverlaySuccessMessage: String = "Scanned successfully", var completionOverlayIncompleteDataMessage: String = "Incomplete scan", var accessibilityDescriptionOpenIntroScreenButton: String = "Open introduction screen.", var accessibilityDescriptionIntroScreenDoneButton: String = "Start scanning", var accessibilityDescriptionCancelButton: String = "Cancel", var accessibilityDescriptionFlashButton: String = "Toggle flash", var accessibilityDescriptionZoomButton: String = "Toggle camera zoom", var accessibilityDescriptionFlipCameraButton: String = "Flip camera", var creditCardUserGuidanceNoCardFound: String = "Looking for credit card...", var creditCardUserGuidanceScanningProgress: String = "Scanning the credit card...", var creditCardUserGuidanceTooDark: String = "Too dark. Please turn on a light.", var creditCardUserGuidanceTooSmall: String = "Please move closer to the credit card.", var creditCardUserGuidanceBadPerspective: String = "Please hold your device straight over the credit card.", 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") : Parcelable
Configuration of the all strings for credit card scanner screen.
Link copied to clipboard
data class CreditCardScannerUiResult(val recognitionStatus: CreditCardScanningStatus, val creditCard: GenericDocument?) : AutoCloseable, Parcelable
Configuration of the credit card scanner RTU UI result.
Link copied to clipboard
data class CreditCardScanningProgressConfiguration(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.