Note

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

Scan Item Definition

Defined in library scandit_datacapture_barcode

ScanItemDefinition

class ScanItemDefinition

Added in version 8.1.0

A definition for a target scan item in the item-based scanning APIs that represents a collection of related scan components. A scan item definition can contain multiple barcode and text components that are logically grouped together.

ScanItemDefinition(identifier, components)

ScanItemDefinition(ScanItemIdentifier identifier,
        List<ScanComponentDefinition> components)

Added in version 8.1.0

A constructor that requires an identifier and a list of ScannedComponent objects that make up the item.

identifier

ScanItemIdentifier get identifier

Added in version 8.1.0

The unique identifier for this scanned item.

onScan

void Function(ScannedItem)? onScan

Added in version 8.1.0

A callback that gets called every time a new scan item is detected.

components

List<ScanComponentDefinition> get components

Added in version 8.1.0

An array of all scan components that make up this item. Components can be either ScannedBarcode or ScannedText objects.