Android Scanbot SDK API reference/io.scanbot.sdk.ui_v2.common

Package-level declarations

Types

Link copied to clipboard
data class ActionBarConfiguration(var flashButton: RoundButton = RoundButton( visible = true, accessibilityDescription = "?accessibilityDescriptionFlashButton", backgroundColor = ScanbotColor("?sbColorSurfaceHigh", isArgb = false), foregroundColor = ScanbotColor("?sbColorOnPrimary", isArgb = false), activeBackgroundColor = ScanbotColor("?sbColorWarning", isArgb = false), activeForegroundColor = ScanbotColor("#1C1B1F", isArgb = false) ), var zoomButton: RoundButton = RoundButton( visible = true, accessibilityDescription = "?accessibilityDescriptionZoomButton", backgroundColor = ScanbotColor("?sbColorSurfaceHigh", isArgb = false), foregroundColor = ScanbotColor("?sbColorOnPrimary", isArgb = false), activeBackgroundColor = ScanbotColor("?sbColorSurfaceHigh", isArgb = false), activeForegroundColor = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), var flipCameraButton: RoundButton = RoundButton( visible = true, accessibilityDescription = "?accessibilityDescriptionFlipCameraButton", backgroundColor = ScanbotColor("?sbColorSurfaceHigh", isArgb = false), foregroundColor = ScanbotColor("?sbColorOnPrimary", isArgb = false), activeBackgroundColor = ScanbotColor("?sbColorWarning", isArgb = false), activeForegroundColor = ScanbotColor("#1C1B1F", isArgb = false) )) : Parcelable

Configuration of the buttons available in the action bar.

Link copied to clipboard
data class BackgroundStyle(var strokeColor: ScanbotColor = ScanbotColor("#FFFFFFFF", isArgb = false), var fillColor: ScanbotColor = ScanbotColor("#FFFFFF30", isArgb = false), var strokeWidth: Double = 2.0) : Parcelable

Configuration of the background appearance for buttons and hints.

Link copied to clipboard
data class BadgedButton(var badgeBackgroundColor: ScanbotColor = ScanbotColor("#FFFFFF", isArgb = false), var badgeForegroundColor: ScanbotColor = ScanbotColor("#C8193C", isArgb = false), var visible: Boolean = true, var backgroundColor: ScanbotColor = ScanbotColor("#0000007A", isArgb = false), var foregroundColor: ScanbotColor = ScanbotColor("#FFFFFF", isArgb = false), var activeBackgroundColor: ScanbotColor = ScanbotColor("#FFCE5C", isArgb = false), var activeForegroundColor: ScanbotColor = ScanbotColor("#1C1B1F", isArgb = false)) : Parcelable

Configuration of the button with a badge.

Link copied to clipboard
data class BadgeStyle(var visible: Boolean = true, var background: BackgroundStyle = BackgroundStyle( ), var foregroundColor: ScanbotColor = ScanbotColor("?sbColorOnSurface", isArgb = false)) : Parcelable

Configuration of the badge.

Link copied to clipboard
data class BarButtonConfiguration(var visible: Boolean = true, var title: StyledText = StyledText( ), var accessibilityDescription: String = "", var background: BackgroundStyle = BackgroundStyle( ), var icon: IconStyle = IconStyle( )) : Parcelable

Configuration of the button located on a bar.

Link copied to clipboard
sealed class BaseViewFinderConfiguration : Parcelable

Base configuration of the scanning interface’s viewfinder, serving as guidance to the user.

Link copied to clipboard
data class ButtonConfiguration(var visible: Boolean = true, var text: String = "", var accessibilityDescription: String = "", var background: BackgroundStyle = BackgroundStyle( ), var foreground: ForegroundStyle = ForegroundStyle( )) : Parcelable

Configuration of the button.

Link copied to clipboard
data class CameraConfiguration(var cameraModule: CameraModule = CameraModule.BACK, var zoomSteps: List<Double> = listOf( 1.0, 2.0, 5.0 ), var defaultZoomFactor: Double = 1.0, var flashEnabled: Boolean = false, var minFocusDistanceLock: Boolean = false, var touchToFocusEnabled: Boolean = false, var pinchToZoomEnabled: Boolean = true, var orientationLockMode: OrientationLockMode = OrientationLockMode.NONE, var cameraPreviewMode: CameraPreviewMode = CameraPreviewMode.FILL_IN, var fpsLimit: Int = 20) : Parcelable

Configuration of the camera settings to be used while scanning.

Link copied to clipboard
enum CameraModule : Enum<CameraModule>

Determines which camera module to use on start-up.

Link copied to clipboard
data class CameraPermissionScreen(var statusBarMode: StatusBarMode = StatusBarMode.DARK, var background: ScanbotColor = ScanbotColor("?sbColorSurface", isArgb = false), var iconBackground: ScanbotColor = ScanbotColor("?sbColorOutline", isArgb = false), var icon: IconStyle = IconStyle( color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), var enableCameraButton: ButtonConfiguration = ButtonConfiguration( text = "?cameraPermissionEnableCameraButton", background = BackgroundStyle( strokeColor = ScanbotColor("?sbColorPrimary", isArgb = false), fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), var closeButton: ButtonConfiguration = ButtonConfiguration( text = "?cameraPermissionCloseButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorPrimary", isArgb = false) ) ), var enableCameraTitle: StyledText = StyledText( text = "?cameraPermissionEnableCameraTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), var enableCameraExplanation: StyledText = StyledText( text = "?cameraPermissionEnableCameraExplanation", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) )) : Parcelable

Configuration of the camera permission request view.

Link copied to clipboard
enum CameraPreviewMode : Enum<CameraPreviewMode>

Configuration of the camera preview mode.

Link copied to clipboard
object Constants
Link copied to clipboard
data class EdgeInsets(var top: Double = 0.0, var left: Double = 0.0, var bottom: Double = 0.0, var right: Double = 0.0) : Parcelable

Represents the insets of a rectangle.

Link copied to clipboard
data class FinderCorneredStyle(var strokeColor: ScanbotColor = ScanbotColor("#FFFFFFFF", isArgb = false), var strokeWidth: Double = 3.0, var cornerRadius: Double = 10.0) : FinderStyle, Parcelable

A variant of the viewfinder displaying only the four corners of the scanning area.

Link copied to clipboard
data class FinderStrokedStyle(var strokeColor: ScanbotColor = ScanbotColor("#FFFFFFFF", isArgb = false), var strokeWidth: Double = 3.0, var cornerRadius: Double = 10.0) : FinderStyle, Parcelable

A variant of the viewfinder displaying a full outline of the scanning area.

Link copied to clipboard
sealed class FinderStyle : Parcelable

The visual appearance of the viewfinder.

Link copied to clipboard
data class ForegroundStyle(var iconVisible: Boolean = true, var color: ScanbotColor = ScanbotColor("#FFFFFF", isArgb = false), var useShadow: Boolean = false) : Parcelable

Configuration of the appearance for foreground elements (e.g. text and/or icons, etc).

Link copied to clipboard
data class IconButton(var visible: Boolean = true, var color: ScanbotColor = ScanbotColor("#FFFFFF", isArgb = false), var accessibilityDescription: String = "") : Parcelable

Configuration of the icon appearance on a button.

Link copied to clipboard
data class IconStyle(var visible: Boolean = true, var color: ScanbotColor = ScanbotColor("#FFFFFF", isArgb = false)) : Parcelable

Configuration of the icon appearance.

Link copied to clipboard
data class IconUserGuidanceConfiguration(var visible: Boolean = true, var icon: IconStyle = IconStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), var title: StyledText = StyledText( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), var background: BackgroundStyle = BackgroundStyle( fillColor = ScanbotColor("?sbColorSurfaceLow", isArgb = false) )) : Parcelable

Configuration of the hint (containing an icon) guiding users through the scanning process.

Link copied to clipboard
enum NavigationBarMode : Enum<NavigationBarMode>

The visual mode used for the navigation bar icons. Android only.

Link copied to clipboard
enum OrientationLockMode : Enum<OrientationLockMode>

Configure the orientation of the interface.

Link copied to clipboard
data class Palette(var sbColorPrimary: ScanbotColor = ScanbotColor("#C8193C", isArgb = false), var sbColorPrimaryDisabled: ScanbotColor = ScanbotColor("#F5F5F5", isArgb = false), var sbColorNegative: ScanbotColor = ScanbotColor("#FF3737", isArgb = false), var sbColorPositive: ScanbotColor = ScanbotColor("#4EFFB4", isArgb = false), var sbColorWarning: ScanbotColor = ScanbotColor("#FFCE5C", isArgb = false), var sbColorSecondary: ScanbotColor = ScanbotColor("#FFEDEE", isArgb = false), var sbColorSecondaryDisabled: ScanbotColor = ScanbotColor("#F5F5F5", isArgb = false), var sbColorOnPrimary: ScanbotColor = ScanbotColor("#FFFFFF", isArgb = false), var sbColorOnSecondary: ScanbotColor = ScanbotColor("#C8193C", isArgb = false), var sbColorSurface: ScanbotColor = ScanbotColor("#FFFFFF", isArgb = false), var sbColorOutline: ScanbotColor = ScanbotColor("#EFEFEF", isArgb = false), var sbColorOnSurfaceVariant: ScanbotColor = ScanbotColor("#707070", isArgb = false), var sbColorOnSurface: ScanbotColor = ScanbotColor("#000000", isArgb = false), var sbColorSurfaceLow: ScanbotColor = ScanbotColor("#00000026", isArgb = false), var sbColorSurfaceHigh: ScanbotColor = ScanbotColor("#0000007A", isArgb = false), var sbColorModalOverlay: ScanbotColor = ScanbotColor("#000000A3", isArgb = false)) : Parcelable

Value palette describing the colors of the scanner screens.

Link copied to clipboard
data class PermanentViewFinderConfiguration(var style: FinderStyle = FinderCorneredStyle( strokeColor = ScanbotColor("?sbColorSurface", isArgb = false), strokeWidth = 2.0, cornerRadius = 10.0 ), var overlayColor: ScanbotColor = ScanbotColor("?sbColorSurfaceLow", isArgb = false), var aspectRatio: AspectRatio = AspectRatio( width = 1.0, height = 1.0 ), var minimumInsets: EdgeInsets = EdgeInsets( top = 16.0, left = 16.0, bottom = 16.0, right = 16.0 ), var preferredHeight: Double = -1.0) : BaseViewFinderConfiguration, Parcelable

Configuration of the scanning interface’s viewfinder, which is always visible to guide the user.

Link copied to clipboard
data class PolygonStyle(var strokeColor: ScanbotColor = ScanbotColor("#FFFFFFFF", isArgb = false), var fillColor: ScanbotColor = ScanbotColor("#FFFFFF30", isArgb = false), var strokeWidth: Double = 2.0, var cornerRadius: Double = 0.0) : Parcelable

Configuration of the polygon appearance.

Link copied to clipboard
data class PopupMenuItem(var title: StyledText = StyledText( ), var accessibilityDescription: String = "", var icon: IconStyle = IconStyle( )) : Parcelable

Configuration for the popup menu items.

Link copied to clipboard
data class RoundButton(var visible: Boolean = true, var accessibilityDescription: String = "", var backgroundColor: ScanbotColor = ScanbotColor("#0000007A", isArgb = false), var foregroundColor: ScanbotColor = ScanbotColor("#FFFFFF", isArgb = false), var activeBackgroundColor: ScanbotColor = ScanbotColor("#FFCE5C", isArgb = false), var activeForegroundColor: ScanbotColor = ScanbotColor("#1C1B1F", isArgb = false)) : Parcelable

Configuration of the round button.

Link copied to clipboard
data class ScanbotAlertDialog(var title: StyledText = StyledText( text = "Title", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), var subtitle: StyledText = StyledText( text = "Standard explanation message text.", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), var sheetColor: ScanbotColor = ScanbotColor("?sbColorSurface", isArgb = false), var modalOverlayColor: ScanbotColor = ScanbotColor("?sbColorModalOverlay", isArgb = false), var dividerColor: ScanbotColor = ScanbotColor("?sbColorOutline", isArgb = false), var okButton: ButtonConfiguration = ButtonConfiguration( background = BackgroundStyle( fillColor = ScanbotColor("?sbColorPrimary", isArgb = false) ) ), var actionButton: ButtonConfiguration = ButtonConfiguration( visible = false, background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ) ), var cancelButton: ButtonConfiguration = ButtonConfiguration( visible = true, background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ) )) : Parcelable

Configuration of the standard alert dialog.

Link copied to clipboard
data class ScanbotColor(var value: String) : Parcelable
Link copied to clipboard
data class ScanCompletionOverlay(var message: StyledText = StyledText( text = "?completionOverlaySuccessMessage", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), var iconColor: ScanbotColor = ScanbotColor("?sbColorOnPrimary", isArgb = false), var overlayBackgroundColor: ScanbotColor = ScanbotColor("?sbColorSurfaceHigh", isArgb = false), var timeout: Int = 1000) : Parcelable

Configuration of the overlay to be shown after the successful scan.

Link copied to clipboard
data class Sound(var successBeepEnabled: Boolean = true, var soundType: SoundType = SoundType.MODERN_BEEP) : Parcelable

Configuration for the sound.

Link copied to clipboard
enum SoundType : Enum<SoundType>

Determines the successful detection sound.

Link copied to clipboard
enum StatusBarMode : Enum<StatusBarMode>

The visual mode used for the status bar icons.

Link copied to clipboard
data class StyledText(var visible: Boolean = true, var text: String = "", var color: ScanbotColor = ScanbotColor("#FFFFFF", isArgb = false), var useShadow: Boolean = false) : Parcelable

Configuration of the text field appearance.

Link copied to clipboard
Link copied to clipboard
data class Timeouts(var autoCancelTimeout: Int = 0, var initialScanDelay: Int = 0) : Parcelable

Configuration of timeouts.

Link copied to clipboard
data class TopBarConfiguration(var title: StyledText = StyledText( visible = false, text = "Scan Item", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), var mode: TopBarMode = TopBarMode.SOLID, var statusBarMode: StatusBarMode = StatusBarMode.LIGHT, var backgroundColor: ScanbotColor = ScanbotColor("?sbColorPrimary", isArgb = false), var cancelButton: ButtonConfiguration = ButtonConfiguration( text = "Cancel", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) )) : Parcelable

Configuration of the top bar's appearance.

Link copied to clipboard
enum TopBarMode : Enum<TopBarMode>

The visual mode used for the top bar.

Link copied to clipboard
data class UserGuidanceConfiguration(var visible: Boolean = true, var title: StyledText = StyledText( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), var background: BackgroundStyle = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("?sbColorSurfaceLow", isArgb = false) )) : Parcelable

Configuration of the hint guiding users through the scanning process.

Link copied to clipboard
data class Vibration(var enabled: Boolean = false) : Parcelable

Configure the vibration.

Link copied to clipboard
data class ViewFinderConfiguration(var style: FinderStyle = FinderCorneredStyle( strokeColor = ScanbotColor("?sbColorSurface", isArgb = false), strokeWidth = 2.0, cornerRadius = 10.0 ), var overlayColor: ScanbotColor = ScanbotColor("?sbColorSurfaceLow", isArgb = false), var aspectRatio: AspectRatio = AspectRatio( width = 1.0, height = 1.0 ), var minimumInsets: EdgeInsets = EdgeInsets( top = 16.0, left = 16.0, bottom = 16.0, right = 16.0 ), var preferredHeight: Double = -1.0, var visible: Boolean = true) : BaseViewFinderConfiguration, Parcelable

Configuration of the scanning interface’s viewfinder, allowing it to be shown or hidden as guidance to the user.