Note

This API is still in beta and may change in future versions of Scandit Data Capture SDK.

Barcode Definition

Defined in package com.scandit.datacapture.usi.capture.component.barcode

BarcodeDefinition
class BarcodeDefinition : ScanComponentDefinition

Added in version 8.0.0

A class that holds the definition for a barcode expected to be scanned as part of a certain ScanItemDefinition.

BarcodeDefinition()
BarcodeDefinition(identifier: BarcodeIdentifier,
        symbologies: Set<Symbology>)

Added in version 8.0.0

A constructor that receives the identifier and symbologies for the barcode definition.

identifier
val identifier: BarcodeIdentifier

Added in version 8.0.0

The unique identifier for this component.

location
var location: Quadrilateral?

Added in version 8.0.0

The expected location of the barcode.

optional
var optional: Boolean

Added in version 8.0.0

Whether the barcode is optional.

symbologies
val symbologies: Set<Symbology>

Added in version 8.0.0

The list of symbologies that the barcode could be using.

preset
var preset: ScanComponentBarcodePreset?

Added in version 8.0.0

A preset to be applied to the barcode definition.

hiddenProperties
var hiddenProperties: String

Added in version 8.0.0

A list of hidden properties to set on the barcode definition.

valueRegexes
var valueRegexes: List<String>

Added in version 8.0.0

A list of value regexes to use when searching for the barcode.

anchorRegexes
var anchorRegexes: List<String>

Added in version 8.0.0

A list of anchor regexes to use when searching for the barcode.

builder(identifier)
fun BarcodeDefinition.builder(identifier: BarcodeIdentifier): BarcodeDefinitionBuilder

Added in version 8.0.0

Creates a builder object that can be used to fluently create a BarcodeDefinition instance.