SparkScan Toast Settings

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

SparkScanToastSettings

class SparkScanToastSettings

Added in version 6.18.0

SparkScanToastSettings()

SparkScanToastSettings(toastEnabled: Boolean,
        toastBackgroundColor: Int?,
        toastTextColor: Int?,
        targetModeEnabledMessage: String?,
        targetModeDisabledMessage: String?,
        continuousModeEnabledMessage: String?,
        continuousModeDisabledMessage: String?,
        scanPausedMessage: String?,
        zoomedInMessage: String?,
        zoomedOutMessage: String?,
        torchEnabledMessage: String?,
        torchDisabledMessage: String?,
        userFacingCameraEnabledMessage: String?,
        worldFacingCameraEnabledMessage: String?)

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

var toastEnabled: Boolean

Added in version 6.18.0

Should toasts be shown or not.

Default is true.

toastBackgroundColor

var toastBackgroundColor: Int?

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

var toastTextColor: Int?

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

var targetModeEnabledMessage: String?

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

var targetModeDisabledMessage: String?

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

var continuousModeEnabledMessage: String?

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

var continuousModeDisabledMessage: String?

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.

scanPausedMessage

var scanPausedMessage: String?

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

var zoomedInMessage: String?

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

var zoomedOutMessage: String?

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

var torchEnabledMessage: String?

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

var torchDisabledMessage: String?

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

var userFacingCameraEnabledMessage: String?

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

var worldFacingCameraEnabledMessage: String?

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()

fun toJson(): String

Added in version 6.18.0

Returns the JSON representation of the toast settings.