Package-level declarations
Types
Link copied to clipboard
A custom image for the introduction screen.
Link copied to clipboard
The default image for the introduction screen.
Link copied to clipboard
No image for the introduction screen.
Link copied to clipboard
The image for the introduction screen of a VIN scanner screen.
Link copied to clipboard
data class VinScannerIntroScreenConfiguration(var image: VinScannerIntroImage = VinIntroDefaultImage( ), 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 VIN scanner.
Link copied to clipboard
data class VinScannerScreenConfiguration(val version: String = "1.0", val screen: String = "VINScanner", var localization: VinScannerScreenTextLocalization = VinScannerScreenTextLocalization( ), 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 finderViewUserGuidance: UserGuidanceConfiguration = UserGuidanceConfiguration( title = StyledText( text = "?finderViewUserGuidance" ) ), 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: VinScannerIntroScreenConfiguration = VinScannerIntroScreenConfiguration( ), 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 = 5.0, height = 1.0 ), preferredHeight = 56.0 ), var scannerConfiguration: VinScannerConfiguration = VinScannerConfiguration( ), var shouldShowWordBoxes: Boolean = true, var wordBoxesFillColor: ScanbotColor = ScanbotColor("#33CCE54C", isArgb = false), var wordBoxesLineColor: ScanbotColor = ScanbotColor("#33CCE599", isArgb = false), var confirmationAlertDialogEnabled: Boolean = false, var confirmationAlertDialog: ScanbotAlertDialog = ScanbotAlertDialog( title = StyledText( text = "?vinConfirmationAlertTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitle = StyledText( 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 = "?vinConfirmationAlertSubmitButton", accessibilityDescription = "?accessibilityDescriptionConfirmationSubmitButton", 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 = "?vinConfirmationAlertCancelButton", accessibilityDescription = "?accessibilityDescriptionConfirmationCancelButton", 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 successOverlay: ScanCompletionOverlay = ScanCompletionOverlay( ), var sound: Sound = Sound( ), var vibration: Vibration = Vibration( ), var keepScreenOn: Boolean = true) : Parcelable
Configuration of the screen for detecting VIN data.
Link copied to clipboard
data class VinScannerScreenTextLocalization(var topBarTitle: String = "VIN Scanner", var topBarCancelButton: String = "Cancel", var topUserGuidance: String = "Point the camera at the VIN", var finderViewUserGuidance: String = "Looking for VIN...", var introScreenTitle: String = "How to scan a VIN", var introScreenDoneButton: String = "Start Scanning", var introScreenText: String = "A VIN (Vehicle Identification Number) is a unique code you'll find on a vehicle's windshield or on the inside of the driver's door. ", var completionOverlaySuccessMessage: String = "Scanned successfully", var accessibilityDescriptionOpenIntroScreenButton: String = "Open VIN Scanner introduction", var accessibilityDescriptionIntroScreenDoneButton: String = "Start VIN scanning", var accessibilityDescriptionCancelButton: String = "Cancel VIN scanning", var vinConfirmationAlertTitle: String = "VIN detected", var vinConfirmationAlertCancelButton: String = "Cancel", var vinConfirmationAlertSubmitButton: String = "Submit", var accessibilityDescriptionConfirmationCancelButton: String = "Cancel VIN scanning", var accessibilityDescriptionConfirmationSubmitButton: String = "Submit VIN scan result", 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") : Parcelable
Configuration of the all strings for generic text scanner screen.
Link copied to clipboard
data class VinScannerUiResult(val textResult: TextPatternScannerResult, val barcodeResult: VinBarcodeResult) : Parcelable
Configuration of the generic text scanner RTU UI result.