SparkScan Toast Settings

Defined under the namespace Scandit.Datacapture.Barcode.Spark.Ui

SparkScanToastSettings

class SparkScanToastSettings

Added in version 6.22.0

constructor(toastEnabled, toastBackgroundColor, toastTextColor, targetModeEnabledMessage, targetModeDisabledMessage, selectionModeOnMessage, selectionModeOffMessage, continuousModeEnabledMessage, continuousModeDisabledMessage, scanPausedMessage, zoomedInMessage, zoomedOutMessage, torchEnabledMessage, torchDisabledMessage, userFacingCameraEnabledMessage, worldFacingCameraEnabledMessage)

constructor(toastEnabled?: boolean,
        toastBackgroundColor?: Color | null,
        toastTextColor?: Color | null,
        targetModeEnabledMessage?: string | null,
        targetModeDisabledMessage?: string | null,
        selectionModeOnMessage?: string | null,
        selectionModeOffMessage?: string | null,
        continuousModeEnabledMessage?: string | null,
        continuousModeDisabledMessage?: string | null,
        scanPausedMessage?: string | null,
        zoomedInMessage?: string | null,
        zoomedOutMessage?: string | null,
        torchEnabledMessage?: string | null,
        torchDisabledMessage?: string | null,
        userFacingCameraEnabledMessage?: string | null,
        worldFacingCameraEnabledMessage?: string | null)

Added in version 8.3.0

Constructs a new SparkScan toast settings with all parameters specified. When called with no parameters (or all parameters as undefined/null), defaults from native will be used. Parameters not provided will use their default values from the native platform.

toastEnabled

toastEnabled: boolean

Added in version 6.22.0

Should toasts be shown or not.

Default is true.

toastBackgroundColor

toastBackgroundColor: Color | null

Added in version 6.22.0

Background color of the toast. If this property is null, a default color will be used.

Default is null.

toastTextColor

toastTextColor: Color | null

Added in version 6.22.0

Text color of the toast. If this property is null, a default color will be used.

Default is null.

targetModeEnabledMessage

targetModeEnabledMessage: string | null

Added in version 6.22.0

Deprecated since version 8.5: Will be removed in 9.0.

Text of the toast when target mode enabled.

Default is null. If this property is null, a default message will be shown. If this property is an empty string, the toast will not be shown.

targetModeDisabledMessage

targetModeDisabledMessage: string | null

Added in version 6.22.0

Deprecated since version 8.5: Will be removed in 9.0.

Text of the toast when target mode disabled.

Default is null. If this property is null, a default message will be shown. If this property is an empty string, the toast will not be shown.

selectionModeOnMessage

selectionModeOnMessage: string | null

Added in version 8.5.0

Shown when SparkScanSettings.selectionMode is set to SelectionMode.On. Replaces the deprecated targetModeEnabledMessage.

Default is null. If this property is null, a default message will be shown. If this property is an empty string, the toast will not be shown.

selectionModeOffMessage

selectionModeOffMessage: string | null

Added in version 8.5.0

Shown when SparkScanSettings.selectionMode is set to SelectionMode.Off. Replaces the deprecated targetModeDisabledMessage.

Default is null. If this property is null, a default message will be shown. If this property is an empty string, the toast will not be shown.

continuousModeEnabledMessage

continuousModeEnabledMessage: string | null

Added in version 6.22.0

Text of the toast when SparkScanScanningBehavior.Continuous capturing mode enabled.

Default is null. If this property is null, a default message will be shown.

If this property is an empty string, the toast will not be shown.

continuousModeDisabledMessage

continuousModeDisabledMessage: string | null

Added in version 6.22.0

Text of the toast when SparkScanScanningBehavior.Continuous capturing mode disabled.

Default is null. If this property is null, a default message will be shown.

If this property is an empty string, the toast will not be shown.

scanPausedMessage

scanPausedMessage: string | null

Added in version 6.23.0

Text of the toast when SparkScanPreviewBehavior.Persistent capturing mode is enabled and scanning is paused.

Default is null. If this property is null, a default message will be shown. If this property is an empty string, the toast will not be shown.

zoomedInMessage

zoomedInMessage: string | null

Added in version 6.23.0

Text of the toast when zooming in.

Default is null. If this property is null, a default message will be shown. If this property is an empty string, the toast will not be shown.

zoomedOutMessage

zoomedOutMessage: string | null

Added in version 6.23.0

Text of the toast when zooming out.

Default is null. If this property is null, a default message will be shown. If this property is an empty string, the toast will not be shown.

torchEnabledMessage

torchEnabledMessage: string | null

Added in version 6.23.0

Text of the toast when torch is enabled.

Default is null. If this property is null, a default message will be shown. If this property is an empty string, the toast will not be shown.

torchDisabledMessage

torchDisabledMessage: string | null

Added in version 6.23.0

Text of the toast when torch is disabled.

Default is null. If this property is null, a default message will be shown. If this property is an empty string, the toast will not be shown.

userFacingCameraEnabledMessage

userFacingCameraEnabledMessage: string | null

Added in version 6.24.0

Text of the toast when user facing camera is enabled.

Default is null. If this property is null, a default message will be shown. If this property is an empty string, the toast will not be shown.

worldFacingCameraEnabledMessage

worldFacingCameraEnabledMessage: string | null

Added in version 6.24.0

Text of the toast when world facing camera is enabled.

Default is null. If this property is null, a default message will be shown. If this property is an empty string, the toast will not be shown.