SparkScan Toast Settings

Defined in package com.scandit.datacapture.barcode.spark.ui

SparkScanToastSettings

class SparkScanToastSettings

Added in version 6.18.0

SparkScanToastSettings()

SparkScanToastSettings(boolean toastEnabled,
        @Nullable Integer toastBackgroundColor,
        @Nullable Integer toastTextColor,
        @Nullable String targetModeEnabledMessage,
        @Nullable String targetModeDisabledMessage,
        @Nullable String continuousModeEnabledMessage,
        @Nullable String continuousModeDisabledMessage,
        @Nullable String cameraTimeoutMessage,
        @Nullable String scanPausedMessage,
        @Nullable String zoomedInMessage,
        @Nullable String zoomedOutMessage,
        @Nullable String torchEnabledMessage,
        @Nullable String torchDisabledMessage,
        @Nullable String userFacingCameraEnabledMessage,
        @Nullable String worldFacingCameraEnabledMessage)

Added in version 6.18.0

Constructs a new SparkScan toast settings to use when creating an instance of the SparkScanViewSettings.

toastEnabled

boolean getToastEnabled()
void setToastEnabled(boolean value)

Added in version 6.18.0

Should toasts be shown or not.

Default is true.

toastBackgroundColor

@Nullable Integer getToastBackgroundColor()
void setToastBackgroundColor(@Nullable Integer value)

Added in version 6.18.0

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

Default is null.

toastTextColor

@Nullable Integer getToastTextColor()
void setToastTextColor(@Nullable Integer value)

Added in version 6.18.0

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

Default is null.

targetModeEnabledMessage

@Nullable String getTargetModeEnabledMessage()
void setTargetModeEnabledMessage(@Nullable String value)

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

@Nullable String getTargetModeDisabledMessage()
void setTargetModeDisabledMessage(@Nullable String value)

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

@Nullable String getContinuousModeEnabledMessage()
void setContinuousModeEnabledMessage(@Nullable String value)

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

@Nullable String getContinuousModeDisabledMessage()
void setContinuousModeDisabledMessage(@Nullable String value)

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

cameraTimeoutMessage

@Nullable String getCameraTimeoutMessage()
void setCameraTimeoutMessage(@Nullable String value)

Added in version 6.18.0

Text of the toast when mini preview is hidden due to a timeout to save battery.

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.

Deprecated since version 6.23: This toast is not displayed anymore due to changes in the SparkScan toast system.

scanPausedMessage

@Nullable String getScanPausedMessage()
void setScanPausedMessage(@Nullable String value)

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

@Nullable String getZoomedInMessage()
void setZoomedInMessage(@Nullable String value)

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

@Nullable String getZoomedOutMessage()
void setZoomedOutMessage(@Nullable String value)

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

@Nullable String getTorchEnabledMessage()
void setTorchEnabledMessage(@Nullable String value)

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

@Nullable String getTorchDisabledMessage()
void setTorchDisabledMessage(@Nullable String value)

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

@Nullable String getUserFacingCameraEnabledMessage()
void setUserFacingCameraEnabledMessage(@Nullable String value)

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

@Nullable String getWorldFacingCameraEnabledMessage()
void setWorldFacingCameraEnabledMessage(@Nullable String value)

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.

toJson()

@NonNull String toJson()

Added in version 6.18.0

Returns the JSON representation of the toast settings.