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

FindAndPickScanningMode

data class FindAndPickScanningMode(var scanningCompletedColor: ScanbotColor = ScanbotColor("?sbColorPositive", isArgb = false), var scanningPartiallyColor: ScanbotColor = ScanbotColor("?sbColorWarning", isArgb = false), var scanningNotScannedColor: ScanbotColor = ScanbotColor("?sbColorOutline", isArgb = false), var allowPartialScan: Boolean = false, var expectedBarcodes: List<ExpectedBarcode> = listOf( ), var countingRepeatDelay: Int = 1000, 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( visible = true, text = "?findAndPickSheetTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false), useShadow = false ), clearAllButton = ButtonConfiguration( visible = true, text = "?sheetResetButton", 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( text = "BARCODE_TITLE", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), barcodeItemSubtitle = StyledText( text = "?findAndPickSheetBarcodeItemSubtitle", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = 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( text = "?sheetPlaceholderTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), placeholderSubtitle = StyledText( text = "?sheetPlaceholderSubtitle", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), placeholderIconBackground = ScanbotColor("?sbColorOutline", isArgb = false), placeholderIcon = IconStyle( visible = true, color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), swipeToDelete = SwipeToDelete( enabled = false, 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 arOverlay: ArOverlayFindAndPickConfiguration = ArOverlayFindAndPickConfiguration( visible = true, automaticSelectionEnabled = true, polygon = FindAndPickArOverlayPolygonConfiguration( partiallyScanned = PolygonStyle( strokeColor = ScanbotColor("?sbColorWarning", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 3.0, cornerRadius = 5.0 ), rejected = PolygonStyle( strokeColor = ScanbotColor("?sbColorSurface", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 3.0, cornerRadius = 5.0 ), completed = PolygonStyle( strokeColor = ScanbotColor("?sbColorPositive", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 3.0, cornerRadius = 5.0 ) ), badge = FindAndPickBadgeConfiguration( partiallyScanned = BadgeStyle( visible = true, background = BackgroundStyle( strokeColor = ScanbotColor("#000000FF", isArgb = false), fillColor = ScanbotColor("?sbColorWarning", isArgb = false), strokeWidth = 0.0 ), foregroundColor = ScanbotColor("?sbColorOnSurface", isArgb = false) ), rejected = BadgeStyle( visible = true, background = BackgroundStyle( strokeColor = ScanbotColor("#000000FF", isArgb = false), fillColor = ScanbotColor("?sbColorSurface", isArgb = false), strokeWidth = 0.0 ), foregroundColor = ScanbotColor("?sbColorOnSurface", isArgb = false) ), completed = BadgeStyle( visible = true, background = BackgroundStyle( strokeColor = ScanbotColor("#000000FF", isArgb = false), fillColor = ScanbotColor("?sbColorPositive", isArgb = false), strokeWidth = 0.0 ), foregroundColor = ScanbotColor("?sbColorOnSurface", isArgb = false) ) ) ), var partialScannedAlertDialogEnabled: Boolean = true, var partialScannedAlertDialog: ScanbotAlertDialog = ScanbotAlertDialog( title = StyledText( text = "?findAndPickPartialAlertTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitle = StyledText( text = "?findAndPickPartialAlertSubtitle", 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 = "?findAndPickPartialAlertSubmitButton", 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 = "?findAndPickPartialAlertCancelButton", 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 confirmationAlertDialogEnabled: Boolean = false, var confirmationAlertDialog: ScanbotAlertDialog = ScanbotAlertDialog( title = StyledText( text = "?findAndPickCompleteAlertTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitle = StyledText( text = "?findAndPickCompleteAlertSubtitle", 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 = "?findAndPickCompleteAlertSubmitButton", 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 = "?findAndPickCompleteAlertCancelButton", 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 ) ) )) : BarcodeUseCase

Configuration of the Find and Pick barcode scanning mode.

Constructors

Link copied to clipboard
constructor(source: Map<String, Any?>)
constructor(json: JsonObject)
constructor(scanningCompletedColor: ScanbotColor = ScanbotColor("?sbColorPositive", isArgb = false), scanningPartiallyColor: ScanbotColor = ScanbotColor("?sbColorWarning", isArgb = false), scanningNotScannedColor: ScanbotColor = ScanbotColor("?sbColorOutline", isArgb = false), allowPartialScan: Boolean = false, expectedBarcodes: List<ExpectedBarcode> = listOf( ), countingRepeatDelay: Int = 1000, 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( visible = true, text = "?findAndPickSheetTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false), useShadow = false ), clearAllButton = ButtonConfiguration( visible = true, text = "?sheetResetButton", 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( text = "BARCODE_TITLE", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), barcodeItemSubtitle = StyledText( text = "?findAndPickSheetBarcodeItemSubtitle", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = 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( text = "?sheetPlaceholderTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), placeholderSubtitle = StyledText( text = "?sheetPlaceholderSubtitle", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), placeholderIconBackground = ScanbotColor("?sbColorOutline", isArgb = false), placeholderIcon = IconStyle( visible = true, color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), swipeToDelete = SwipeToDelete( enabled = false, 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) ) ), arOverlay: ArOverlayFindAndPickConfiguration = ArOverlayFindAndPickConfiguration( visible = true, automaticSelectionEnabled = true, polygon = FindAndPickArOverlayPolygonConfiguration( partiallyScanned = PolygonStyle( strokeColor = ScanbotColor("?sbColorWarning", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 3.0, cornerRadius = 5.0 ), rejected = PolygonStyle( strokeColor = ScanbotColor("?sbColorSurface", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 3.0, cornerRadius = 5.0 ), completed = PolygonStyle( strokeColor = ScanbotColor("?sbColorPositive", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 3.0, cornerRadius = 5.0 ) ), badge = FindAndPickBadgeConfiguration( partiallyScanned = BadgeStyle( visible = true, background = BackgroundStyle( strokeColor = ScanbotColor("#000000FF", isArgb = false), fillColor = ScanbotColor("?sbColorWarning", isArgb = false), strokeWidth = 0.0 ), foregroundColor = ScanbotColor("?sbColorOnSurface", isArgb = false) ), rejected = BadgeStyle( visible = true, background = BackgroundStyle( strokeColor = ScanbotColor("#000000FF", isArgb = false), fillColor = ScanbotColor("?sbColorSurface", isArgb = false), strokeWidth = 0.0 ), foregroundColor = ScanbotColor("?sbColorOnSurface", isArgb = false) ), completed = BadgeStyle( visible = true, background = BackgroundStyle( strokeColor = ScanbotColor("#000000FF", isArgb = false), fillColor = ScanbotColor("?sbColorPositive", isArgb = false), strokeWidth = 0.0 ), foregroundColor = ScanbotColor("?sbColorOnSurface", isArgb = false) ) ) ), partialScannedAlertDialogEnabled: Boolean = true, partialScannedAlertDialog: ScanbotAlertDialog = ScanbotAlertDialog( title = StyledText( text = "?findAndPickPartialAlertTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitle = StyledText( text = "?findAndPickPartialAlertSubtitle", 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 = "?findAndPickPartialAlertSubmitButton", 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 = "?findAndPickPartialAlertCancelButton", 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 ) ) ), confirmationAlertDialogEnabled: Boolean = false, confirmationAlertDialog: ScanbotAlertDialog = ScanbotAlertDialog( title = StyledText( text = "?findAndPickCompleteAlertTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitle = StyledText( text = "?findAndPickCompleteAlertSubtitle", 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 = "?findAndPickCompleteAlertSubmitButton", 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 = "?findAndPickCompleteAlertCancelButton", 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 ) ) ))

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
open override val _type: String
Link copied to clipboard
var allowPartialScan: Boolean

If the user is allowed to finish the scanning process without scanning all the expected barcodes. Default is false

Link copied to clipboard
var arOverlay: ArOverlayFindAndPickConfiguration

Configuration of the AR overlay.

Link copied to clipboard
var confirmationAlertDialog: ScanbotAlertDialog

Configuration of the confirmation alert dialog.

Link copied to clipboard
var confirmationAlertDialogEnabled: Boolean

If the confirmation alert dialog is enabled. Default is false

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 expectedBarcodes: List<ExpectedBarcode>

List of barcodes that the user has to find and scan.

Link copied to clipboard
var manualCountEditDialog: ManualCountEditDialog

Configuration of the dialog to manually edit the barcode count.

Link copied to clipboard
var partialScannedAlertDialog: ScanbotAlertDialog

Configuration of the partial scanned alert dialog.

Link copied to clipboard
var partialScannedAlertDialogEnabled: Boolean

If the partial scanned alert dialog is enabled. Default is true

Link copied to clipboard
var scanningCompletedColor: ScanbotColor

Color of the selected barcode. Default is "?sbColorPositive"

Link copied to clipboard
var scanningNotScannedColor: ScanbotColor

Color of the not scanned barcode . Default is "?sbColorOutline"

Link copied to clipboard
var scanningPartiallyColor: ScanbotColor

Color of the partially scanned barcode. Default is "?sbColorWarning"

Link copied to clipboard
var sheet: Sheet

Configuration of the preview mode for the barcodes required to be found and scanned.

Link copied to clipboard
var sheetContent: SheetContent

Configuration of the list of barcodes required to be found and scanned.

Functions

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