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(@NonNull BarcodeIdentifier identifier,
        @NonNull Set<Symbology> symbologies)

Added in version 8.0.0

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

identifier

@NonNull BarcodeIdentifier getIdentifier()

Added in version 8.0.0

The unique identifier for this component.

location

@Nullable Quadrilateral getLocation()
void setLocation(@Nullable Quadrilateral value)

Added in version 8.0.0

The expected location of the barcode.

optional

boolean getOptional()
void setOptional(boolean value)

Added in version 8.0.0

Whether the barcode is optional.

symbologies

@NonNull Set<Symbology> getSymbologies()

Added in version 8.0.0

The list of symbologies that the barcode could be using.

preset

ScanComponentBarcodePreset getPreset()
void setPreset(ScanComponentBarcodePreset value)

Added in version 8.0.0

A preset to be applied to the barcode definition.

hiddenProperties

@NonNull String getHiddenProperties()
void setHiddenProperties(@NonNull String value)

Added in version 8.0.0

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

valueRegexes

@NonNull List<@NonNull String> getValueRegexes()
void setValueRegexes(@NonNull List<@NonNull String> value)

Added in version 8.0.0

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

anchorRegexes

@NonNull List<@NonNull String> getAnchorRegexes()
void setAnchorRegexes(@NonNull List<@NonNull String> value)

Added in version 8.0.0

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

builder(identifier)

static @NonNull BarcodeDefinitionBuilder builder(@NonNull BarcodeIdentifier identifier)

Added in version 8.0.0

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