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 with default values loaded from native. Use this constructor when you want to use the platform’s default toast configuration. For Capacitor, Cordova, and React Native, use the parameterized constructor with no arguments instead.
- 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 nil, a default color will be used.
Default is nil.
- toastTextColor
open var toastTextColor: UIColor? { get, set }
Added in version 6.18.0
Text color of the toast. If this property is nil, a default color will be used.
Default is nil.
- targetModeEnabledMessage
open var targetModeEnabledMessage: String? { get, set }
Added in version 6.18.0
Text of the toast when target mode enabled.
Default is nil. If this property is nil, 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 nil. If this property is nil, 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 nil. If this property is nil, 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 nil. If this property is nil, 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 nil. If this property is nil, 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 nil. If this property is nil, 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 nil. If this property is nil, 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 nil. If this property is nil, 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 nil. If this property is nil, 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 nil. If this property is nil, 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 nil. If this property is nil, a default message will be shown. If this property is an empty string, the toast will not be shown.