SparkScan Toast Settings

Defined in framework ScanditBarcodeCapture

SDCSparkScanToastSettings
open class SDCSparkScanToastSettings : NSObject

Added in version 6.18.0

init
init()

Added in version 6.18.0

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

isToastEnabled
open var isToastEnabled: Bool { get, set }

Added in version 6.18.0

Should toasts be shown or not.

Default is true.

toastBackgroundColor
open var toastBackgroundColor: UIColor? { get, set }

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
open var toastTextColor: UIColor? { get, set }

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
open var targetModeEnabledMessage: String? { get, set }

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
open var targetModeDisabledMessage: String? { get, set }

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
open var continuousModeEnabledMessage: String? { get, set }

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
open var continuousModeDisabledMessage: String? { get, set }

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
open var scanPausedMessage: String? { get, set }

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
open var zoomedInMessage: String? { get, set }

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
open var zoomedOutMessage: String? { get, set }

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
open var torchEnabledMessage: String? { get, set }

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
open var torchDisabledMessage: String? { get, set }

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
open var userFacingCameraEnabledMessage: String? { get, set }

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
open var worldFacingCameraEnabledMessage: String? { get, set }

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.

jsonString
open var jsonString: String { get }

Added in version 6.18.0

Returns the JSON representation of the toast settings.