SparkScan Toast Settings

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

SparkScanToastSettings

class SparkScanToastSettings

Added in version 6.18.0

Note

The SparkScan Toast APIs are still in beta and may change in future versions of Scandit Data Capture SDK.

SparkScanToastSettings()

SparkScanToastSettings(boolean toastEnabled,
        @Nullable Integer toastBackgroundColor,
        @Nullable Integer toastTextColor,
        @NonNull String targetModeEnabledMessage,
        @NonNull String targetModeDisabledMessage,
        @NonNull String continuousModeEnabledMessage,
        @NonNull String continuousModeDisabledMessage,
        @NonNull String cameraTimeoutMessage)

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 false.

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.

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.

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.

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.

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.

toJson()

@NonNull String toJson()

Added in version 6.18.0

Returns the JSON representation of the toast settings.