scanbot-sdk-compose-multiplatform/io.scanbot.sdk.compose.multiplatform.configuration/MultipleScanningMode

MultipleScanningMode

data class MultipleScanningMode(var countingRepeatDelay: Int = 1000, var mode: MultipleBarcodesScanningMode = MultipleBarcodesScanningMode.COUNTING, var sheet: Sheet = Sheet( mode = SheetMode.COLLAPSED_SHEET, collapsedVisibleHeight = CollapsedVisibleHeight.SMALL, listButton = BadgedButton( badgeBackgroundColor = ScanbotColor("?sbColorSurface", isArgb = false), badgeForegroundColor = ScanbotColor("?sbColorPrimary", isArgb = false), visible = true, backgroundColor = ScanbotColor("?sbColorSurfaceHigh", isArgb = false), foregroundColor = ScanbotColor("?sbColorOnPrimary", isArgb = false), activeBackgroundColor = ScanbotColor("?sbColorSurfaceHigh", isArgb = false), activeForegroundColor = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), var sheetContent: SheetContent = SheetContent( sheetColor = ScanbotColor("?sbColorSurface", isArgb = false), dividerColor = ScanbotColor("?sbColorOutline", isArgb = false), manualCountChangeEnabled = true, manualCountOutlineColor = ScanbotColor("?sbColorOutline", isArgb = false), manualCountChangeColor = ScanbotColor("?sbColorPrimary", isArgb = false), title = StyledText( text = "?multipleModeSheetTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), clearAllButton = ButtonConfiguration( visible = true, text = "?sheetClearAllButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 1.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorOnSurface", isArgb = false), useShadow = false ) ), barcodeItemTitle = StyledText( visible = true, text = "BARCODE_TITLE", color = ScanbotColor("?sbColorOnSurface", isArgb = false), useShadow = false ), barcodeItemSubtitle = StyledText( visible = true, text = "BARCODE_SUBTITLE", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false), useShadow = false ), barcodeItemImageVisible = true, submitButton = ButtonConfiguration( visible = true, text = "?sheetSubmitButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 1.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorOnSurface", isArgb = false), useShadow = false ) ), startScanningButton = ButtonConfiguration( visible = true, text = "?sheetStartScanningButton", background = BackgroundStyle( strokeColor = ScanbotColor("?sbColorPrimary", isArgb = false), fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 1.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorOnPrimary", isArgb = false), useShadow = false ) ), placeholderTitle = StyledText( visible = true, text = "?sheetPlaceholderTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false), useShadow = false ), placeholderSubtitle = StyledText( visible = true, text = "?sheetPlaceholderSubtitle", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false), useShadow = false ), placeholderIconBackground = ScanbotColor("?sbColorOutline", isArgb = false), placeholderIcon = IconStyle( visible = true, color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), swipeToDelete = SwipeToDelete( enabled = true, backgroundColor = ScanbotColor("?sbColorNegative", isArgb = false), iconColor = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), var manualCountEditDialog: ManualCountEditDialog = ManualCountEditDialog( sheetColor = ScanbotColor("?sbColorSurface", isArgb = false), dividerColor = ScanbotColor("?sbColorOutline", isArgb = false), modalOverlayColor = ScanbotColor("?sbColorModalOverlay", isArgb = false), title = StyledText( text = "?manualCountEditDialogTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), info = StyledText( text = "?manualCountEditDialogInfo", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), updateButton = ButtonConfiguration( visible = true, text = "?manualCountEditDialogUpdateButton", background = BackgroundStyle( strokeColor = ScanbotColor("?sbColorPrimary", isArgb = false), fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 1.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorOnPrimary", isArgb = false), useShadow = false ) ), cancelButton = ButtonConfiguration( visible = true, text = "?manualCountEditDialogCancelButton", 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 ) ), clearTextButton = IconStyle( visible = true, color = ScanbotColor("?sbColorOnSurfaceVariant", 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), useShadow = false ) ), cancelButton = ButtonConfiguration( visible = true, 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), useShadow = false ) ) ) ), var arOverlay: ArOverlayGeneralConfiguration = ArOverlayGeneralConfiguration( visible = false, counterBadge = BadgeStyle( visible = true, background = BackgroundStyle( strokeColor = ScanbotColor("#FF000000", 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( visible = true, text = "BARCODE_SUBTITLE", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false), useShadow = false ), titleDeselected = StyledText( visible = true, text = "BARCODE_TITLE", color = ScanbotColor("?sbColorOnSurface", isArgb = false), useShadow = false ), subtitleDeselected = StyledText( text = "BARCODE_SUBTITLE", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = 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

Configuration of the mode for scanning multiple barcodes.

Constructors

Link copied to clipboard
constructor(source: Map<String, Any?>)
constructor(json: JsonObject)
constructor(countingRepeatDelay: Int = 1000, mode: MultipleBarcodesScanningMode = MultipleBarcodesScanningMode.COUNTING, sheet: Sheet = Sheet( mode = SheetMode.COLLAPSED_SHEET, collapsedVisibleHeight = CollapsedVisibleHeight.SMALL, listButton = BadgedButton( badgeBackgroundColor = ScanbotColor("?sbColorSurface", isArgb = false), badgeForegroundColor = ScanbotColor("?sbColorPrimary", isArgb = false), visible = true, backgroundColor = ScanbotColor("?sbColorSurfaceHigh", isArgb = false), foregroundColor = ScanbotColor("?sbColorOnPrimary", isArgb = false), activeBackgroundColor = ScanbotColor("?sbColorSurfaceHigh", isArgb = false), activeForegroundColor = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), sheetContent: SheetContent = SheetContent( sheetColor = ScanbotColor("?sbColorSurface", isArgb = false), dividerColor = ScanbotColor("?sbColorOutline", isArgb = false), manualCountChangeEnabled = true, manualCountOutlineColor = ScanbotColor("?sbColorOutline", isArgb = false), manualCountChangeColor = ScanbotColor("?sbColorPrimary", isArgb = false), title = StyledText( text = "?multipleModeSheetTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), clearAllButton = ButtonConfiguration( visible = true, text = "?sheetClearAllButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 1.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorOnSurface", isArgb = false), useShadow = false ) ), barcodeItemTitle = StyledText( visible = true, text = "BARCODE_TITLE", color = ScanbotColor("?sbColorOnSurface", isArgb = false), useShadow = false ), barcodeItemSubtitle = StyledText( visible = true, text = "BARCODE_SUBTITLE", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false), useShadow = false ), barcodeItemImageVisible = true, submitButton = ButtonConfiguration( visible = true, text = "?sheetSubmitButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 1.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorOnSurface", isArgb = false), useShadow = false ) ), startScanningButton = ButtonConfiguration( visible = true, text = "?sheetStartScanningButton", background = BackgroundStyle( strokeColor = ScanbotColor("?sbColorPrimary", isArgb = false), fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 1.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorOnPrimary", isArgb = false), useShadow = false ) ), placeholderTitle = StyledText( visible = true, text = "?sheetPlaceholderTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false), useShadow = false ), placeholderSubtitle = StyledText( visible = true, text = "?sheetPlaceholderSubtitle", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false), useShadow = false ), placeholderIconBackground = ScanbotColor("?sbColorOutline", isArgb = false), placeholderIcon = IconStyle( visible = true, color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), swipeToDelete = SwipeToDelete( enabled = true, backgroundColor = ScanbotColor("?sbColorNegative", isArgb = false), iconColor = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), manualCountEditDialog: ManualCountEditDialog = ManualCountEditDialog( sheetColor = ScanbotColor("?sbColorSurface", isArgb = false), dividerColor = ScanbotColor("?sbColorOutline", isArgb = false), modalOverlayColor = ScanbotColor("?sbColorModalOverlay", isArgb = false), title = StyledText( text = "?manualCountEditDialogTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), info = StyledText( text = "?manualCountEditDialogInfo", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), updateButton = ButtonConfiguration( visible = true, text = "?manualCountEditDialogUpdateButton", background = BackgroundStyle( strokeColor = ScanbotColor("?sbColorPrimary", isArgb = false), fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 1.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorOnPrimary", isArgb = false), useShadow = false ) ), cancelButton = ButtonConfiguration( visible = true, text = "?manualCountEditDialogCancelButton", 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 ) ), clearTextButton = IconStyle( visible = true, color = ScanbotColor("?sbColorOnSurfaceVariant", 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), useShadow = false ) ), cancelButton = ButtonConfiguration( visible = true, 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), useShadow = false ) ) ) ), arOverlay: ArOverlayGeneralConfiguration = ArOverlayGeneralConfiguration( visible = false, counterBadge = BadgeStyle( visible = true, background = BackgroundStyle( strokeColor = ScanbotColor("#FF000000", 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( visible = true, text = "BARCODE_SUBTITLE", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false), useShadow = false ), titleDeselected = StyledText( visible = true, text = "BARCODE_TITLE", color = ScanbotColor("?sbColorOnSurface", isArgb = false), useShadow = false ), subtitleDeselected = StyledText( text = "BARCODE_SUBTITLE", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = 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 barcodeInfoMapping: BarcodeInfoMapping

Appearance of the barcode info mapping.

Link copied to clipboard
var countingRepeatDelay: Int

Time interval in milliseconds before a barcode is counted again. 0 = no delay. The default value is 1000. Default is 1000

Link copied to clipboard
var manualCountEditDialog: ManualCountEditDialog

Configuration of the dialog to manually edit the barcode count.

Link copied to clipboard
var mode: MultipleBarcodesScanningMode

Mode used for scanning multiple barcodes. Default is COUNTING

Link copied to clipboard
var sheet: Sheet

Configuration of the preview mode for scanning multiple barcodes.

Link copied to clipboard
var sheetContent: SheetContent

Configuration of the list containing the barcodes that have already been scanned.

Functions

Link copied to clipboard
open override fun toJson(): JsonObject