SparkScan Toast Settings

Defined in framework ScanditBarcodeCapture

SDCSparkScanToastSettings
@interface SDCSparkScanToastSettings : NSObject

Added in version 6.18.0

toastEnabled
@property (nonatomic, assign, getter=isToastEnabled) BOOL toastEnabled

Added in version 6.18.0

Should toasts be shown or not.

Default is YES.

toastBackgroundColor
@property (nonatomic, strong, nullable) UIColor *toastBackgroundColor

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
@property (nonatomic, strong, nullable) UIColor *toastTextColor

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
@property (nonatomic, strong, nullable) NSString *targetModeEnabledMessage

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
@property (nonatomic, strong, nullable) NSString *targetModeDisabledMessage

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
@property (nonatomic, strong, nullable) NSString *continuousModeEnabledMessage

Added in version 6.18.0

Text of the toast when SDCSparkScanScanningBehaviorContinuous 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
@property (nonatomic, strong, nullable) NSString *continuousModeDisabledMessage

Added in version 6.18.0

Text of the toast when SDCSparkScanScanningBehaviorContinuous 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.

cameraTimeoutMessage
@property (nonatomic, strong, nullable) NSString *cameraTimeoutMessage

Added in version 6.18.0

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

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.

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

scanPausedMessage
@property (nonatomic, strong, nullable) NSString *scanPausedMessage

Added in version 6.23.0

Text of the toast when SDCSparkScanPreviewBehaviorPersistent 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
@property (nonatomic, strong, nullable) NSString *zoomedInMessage

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
@property (nonatomic, strong, nullable) NSString *zoomedOutMessage

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
@property (nonatomic, strong, nullable) NSString *torchEnabledMessage

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
@property (nonatomic, strong, nullable) NSString *torchDisabledMessage

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
@property (nonatomic, strong, nullable) NSString *userFacingCameraEnabledMessage

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
@property (nonatomic, strong, nullable) NSString *worldFacingCameraEnabledMessage

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.

JSONString
@property (nonatomic, nonnull, readonly) NSString *JSONString

Added in version 6.18.0

Returns the JSON representation of the toast settings.