SparkScan Toast Settings

Defined in library scandit_datacapture_barcode_spark_ui

SparkScanToastSettings

class SparkScanToastSettings

Added in version 6.20.0

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

SparkScanToastSettings({bool? toastEnabled,
        Color? toastTextColor,
        Color? toastBackgroundColor,
        String? targetModeEnabledMessage,
        String? targetModeDisabledMessage,
        String? continuousModeEnabledMessage,
        String? continuousModeDisabledMessage,
        String? scanPausedMessage,
        String? zoomedInMessage,
        String? zoomedOutMessage,
        String? torchEnabledMessage,
        String? torchDisabledMessage,
        String? userFacingCameraEnabledMessage,
        String? worldFacingCameraEnabledMessage})

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

bool toastEnabled

Added in version 6.20.0

Should toasts be shown or not.

Default is true.

toastBackgroundColor

Color? toastBackgroundColor

Added in version 6.20.0

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

Default is null.

toastTextColor

Color? toastTextColor

Added in version 6.20.0

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

Default is null.

targetModeEnabledMessage

String? targetModeEnabledMessage

Added in version 6.20.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

String? targetModeDisabledMessage

Added in version 6.20.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.

continuousModeEnabledMessage

String? continuousModeEnabledMessage

Added in version 6.20.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

String? continuousModeDisabledMessage

Added in version 6.20.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

String? scanPausedMessage

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

String? zoomedInMessage

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

String? zoomedOutMessage

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

String? torchEnabledMessage

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

String? torchDisabledMessage

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

String? userFacingCameraEnabledMessage

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

String? worldFacingCameraEnabledMessage

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.