Android Scanbot Barcode SDK API reference/io.scanbot.sdk.ui_v2.barcode.configuration/SingleScanningMode

SingleScanningMode

data class SingleScanningMode(var confirmationSheetEnabled: Boolean = false, var barcodeImageVisible: Boolean = true, var sheetColor: ScanbotColor = ScanbotColor("?sbColorSurface", isArgb = false), var dividerColor: ScanbotColor = ScanbotColor("?sbColorOutline", isArgb = false), var modalOverlayColor: ScanbotColor = ScanbotColor("?sbColorModalOverlay", isArgb = false), var barcodeTitle: StyledText = StyledText( text = "BARCODE_TITLE", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), var barcodeSubtitle: StyledText = StyledText( text = "BARCODE_SUBTITLE", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), var submitButton: ButtonConfiguration = ButtonConfiguration( visible = true, text = "?sheetSubmitButton", background = BackgroundStyle( strokeColor = ScanbotColor("?sbColorPrimary", isArgb = false), fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 1.0 ), foreground = ForegroundStyle( iconVisible = true, color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), var cancelButton: ButtonConfiguration = ButtonConfiguration( visible = true, text = "?singleModeConfirmationCancelButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 1.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorPrimary", isArgb = false) ) ), var barcodeInfoMapping: BarcodeInfoMapping = BarcodeInfoMapping( sheetColor = ScanbotColor("?sbColorSurface", isArgb = false), dividerColor = ScanbotColor("?sbColorOutline", isArgb = false), modalOverlayColor = ScanbotColor("?sbColorModalOverlay", isArgb = false), loadingMessage = StyledText( text = "?barcodeInfoMappingLoadingMessage", color = ScanbotColor("?sbColorPrimary", isArgb = false) ), errorState = BarcodeItemErrorState( title = StyledText( text = "?barcodeInfoMappingErrorStateTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitle = StyledText( text = "?barcodeInfoMappingErrorStateSubtitle", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), retryButton = ButtonConfiguration( visible = true, text = "?barcodeInfoMappingErrorStateRetryButton", background = BackgroundStyle( strokeColor = ScanbotColor("?sbColorPrimary", isArgb = false), fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 1.0 ), foreground = ForegroundStyle( iconVisible = true, color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), cancelButton = ButtonConfiguration( text = "?barcodeInfoMappingErrorStateCancelButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 1.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorPrimary", isArgb = false) ) ) ) ), var arOverlay: ArOverlayGeneralConfiguration = ArOverlayGeneralConfiguration( visible = false, counterBadge = BadgeStyle( visible = true, background = BackgroundStyle( strokeColor = ScanbotColor("#000000FF", isArgb = false), fillColor = ScanbotColor("?sbColorPositive", isArgb = false), strokeWidth = 0.0 ), foregroundColor = ScanbotColor("?sbColorOnSurface", isArgb = false) ), automaticSelectionEnabled = false, barcodeItemInfoPosition = BarcodeItemInfoPosition.BELOW, polygon = ArOverlayPolygonConfiguration( visible = true, deselected = PolygonStyle( strokeColor = ScanbotColor("?sbColorSurface", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 3.0, cornerRadius = 5.0 ), selected = PolygonStyle( strokeColor = ScanbotColor("?sbColorPositive", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 3.0, cornerRadius = 5.0 ) ), barcodeItemConfiguration = BarcodeItemConfiguration( imageVisible = true, titleSelected = StyledText( text = "BARCODE_TITLE", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitleSelected = StyledText( text = "BARCODE_SUBTITLE", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), titleDeselected = StyledText( text = "BARCODE_TITLE", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitleDeselected = StyledText( visible = true, text = "BARCODE_SUBTITLE", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false), useShadow = false ), backgroundSelected = PolygonStyle( strokeColor = ScanbotColor("?sbColorPositive", isArgb = false), fillColor = ScanbotColor("?sbColorPositive", isArgb = false), strokeWidth = 1.0, cornerRadius = 5.0 ), backgroundDeselected = PolygonStyle( strokeColor = ScanbotColor("?sbColorSurface", isArgb = false), fillColor = ScanbotColor("?sbColorSurface", isArgb = false), strokeWidth = 1.0, cornerRadius = 5.0 ) ) )) : BarcodeUseCase, Parcelable

Configuration of the single barcode scanning mode.

Constructors

Link copied to clipboard
constructor(source: Map<String, Any?>)
constructor(json: JSONObject)
constructor(confirmationSheetEnabled: Boolean = false, barcodeImageVisible: Boolean = true, sheetColor: ScanbotColor = ScanbotColor("?sbColorSurface", isArgb = false), dividerColor: ScanbotColor = ScanbotColor("?sbColorOutline", isArgb = false), modalOverlayColor: ScanbotColor = ScanbotColor("?sbColorModalOverlay", isArgb = false), barcodeTitle: StyledText = StyledText( text = "BARCODE_TITLE", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), barcodeSubtitle: StyledText = StyledText( text = "BARCODE_SUBTITLE", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), submitButton: ButtonConfiguration = ButtonConfiguration( visible = true, text = "?sheetSubmitButton", background = BackgroundStyle( strokeColor = ScanbotColor("?sbColorPrimary", isArgb = false), fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 1.0 ), foreground = ForegroundStyle( iconVisible = true, color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), cancelButton: ButtonConfiguration = ButtonConfiguration( visible = true, text = "?singleModeConfirmationCancelButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 1.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorPrimary", isArgb = false) ) ), barcodeInfoMapping: BarcodeInfoMapping = BarcodeInfoMapping( sheetColor = ScanbotColor("?sbColorSurface", isArgb = false), dividerColor = ScanbotColor("?sbColorOutline", isArgb = false), modalOverlayColor = ScanbotColor("?sbColorModalOverlay", isArgb = false), loadingMessage = StyledText( text = "?barcodeInfoMappingLoadingMessage", color = ScanbotColor("?sbColorPrimary", isArgb = false) ), errorState = BarcodeItemErrorState( title = StyledText( text = "?barcodeInfoMappingErrorStateTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitle = StyledText( text = "?barcodeInfoMappingErrorStateSubtitle", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), retryButton = ButtonConfiguration( visible = true, text = "?barcodeInfoMappingErrorStateRetryButton", background = BackgroundStyle( strokeColor = ScanbotColor("?sbColorPrimary", isArgb = false), fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 1.0 ), foreground = ForegroundStyle( iconVisible = true, color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), cancelButton = ButtonConfiguration( text = "?barcodeInfoMappingErrorStateCancelButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 1.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorPrimary", isArgb = false) ) ) ) ), arOverlay: ArOverlayGeneralConfiguration = ArOverlayGeneralConfiguration( visible = false, counterBadge = BadgeStyle( visible = true, background = BackgroundStyle( strokeColor = ScanbotColor("#000000FF", isArgb = false), fillColor = ScanbotColor("?sbColorPositive", isArgb = false), strokeWidth = 0.0 ), foregroundColor = ScanbotColor("?sbColorOnSurface", isArgb = false) ), automaticSelectionEnabled = false, barcodeItemInfoPosition = BarcodeItemInfoPosition.BELOW, polygon = ArOverlayPolygonConfiguration( visible = true, deselected = PolygonStyle( strokeColor = ScanbotColor("?sbColorSurface", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 3.0, cornerRadius = 5.0 ), selected = PolygonStyle( strokeColor = ScanbotColor("?sbColorPositive", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 3.0, cornerRadius = 5.0 ) ), barcodeItemConfiguration = BarcodeItemConfiguration( imageVisible = true, titleSelected = StyledText( text = "BARCODE_TITLE", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitleSelected = StyledText( text = "BARCODE_SUBTITLE", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), titleDeselected = StyledText( text = "BARCODE_TITLE", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitleDeselected = StyledText( visible = true, text = "BARCODE_SUBTITLE", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false), useShadow = false ), backgroundSelected = PolygonStyle( strokeColor = ScanbotColor("?sbColorPositive", isArgb = false), fillColor = ScanbotColor("?sbColorPositive", isArgb = false), strokeWidth = 1.0, cornerRadius = 5.0 ), backgroundDeselected = PolygonStyle( strokeColor = ScanbotColor("?sbColorSurface", isArgb = false), fillColor = ScanbotColor("?sbColorSurface", isArgb = false), strokeWidth = 1.0, cornerRadius = 5.0 ) ) ))

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
open override val _type: String
Link copied to clipboard
var arOverlay: ArOverlayGeneralConfiguration

Configuration of the AR overlay.

Link copied to clipboard
var barcodeImageVisible: Boolean

If enabled, the barcode image will be shown on the confirmation sheet.

Link copied to clipboard
var barcodeInfoMapping: BarcodeInfoMapping

Appearance of the barcode info mapping.

Link copied to clipboard
var barcodeSubtitle: StyledText

Appearance of the barcode subtitle (the barcode's symbology) on the confirmation sheet.

Link copied to clipboard
var barcodeTitle: StyledText

Appearance of the barcode title (the barcode's value) on the confirmation sheet.

Link copied to clipboard
var cancelButton: ButtonConfiguration

Appearance of the cancel button on the confirmation sheet.

Link copied to clipboard
var confirmationSheetEnabled: Boolean

If enabled, the confirmation sheet will be shown after the barcode has been scanned.

Link copied to clipboard
var dividerColor: ScanbotColor

Color of the divider and separator lines in the confirmation sheet.

Link copied to clipboard
var modalOverlayColor: ScanbotColor

Background color of the overlay surrounding the confirmation sheet.

Link copied to clipboard
var sheetColor: ScanbotColor

Color of the confirmation sheet's background.

Link copied to clipboard
var submitButton: ButtonConfiguration

Appearance of the confirm button on the confirmation sheet.

Functions

Link copied to clipboard
open override fun clone(): SingleScanningMode
Link copied to clipboard
open override fun toJson(config: ToJsonConfiguration): JSONObject