ALScanFeedbackConfig Class Reference

Inherits from NSObject
Conforms to ALJSONStringRepresentable
Declared in ALScanFeedbackConfig.h

Overview

Object configuring how the scan view responds when it finds an object it recognizes

  feedbackStyle

The scan feedback style displayed when an object is detected

@property (nonatomic, readonly) ALScanFeedbackStyle feedbackStyle

Declared In

ALScanFeedbackConfig.h

  strokeColor

Stroke color of the visual feedback. Use a “XXXXXX” hex string

@property (nonatomic, readonly) NSString *strokeColor

Declared In

ALScanFeedbackConfig.h

  fillColor

Stroke color of the visual feedback. Use a “XXXXXXXX” hex string with the first two characters representing the alpha component of the fill

@property (nonatomic, readonly) NSString *fillColor

Declared In

ALScanFeedbackConfig.h

  strokeWidth

Stroke width of the visual feedback

@property (nonatomic, readonly) NSInteger strokeWidth

Declared In

ALScanFeedbackConfig.h

  cornerRadius

The corner rounding level for visual feedback

@property (nonatomic, readonly) NSInteger cornerRadius

Declared In

ALScanFeedbackConfig.h

  redrawTimeout

The amount of time the visual feedback remains on screen until it is removed

@property (nonatomic, assign) NSInteger redrawTimeout

Declared In

ALScanFeedbackConfig.h

  animationDuration

How long the animation lasts, in ms

@property (nonatomic, readonly) NSInteger animationDuration

Declared In

ALScanFeedbackConfig.h

  animationStyle

The animation style used with the visual feedback drawn on the scan view

@property (nonatomic, readonly) ALFeedbackAnimationStyle animationStyle

Declared In

ALScanFeedbackConfig.h

  blinkAnimationOnResult

Indicate whether a brief “flicker” of the scan view is shown when an object is successfully scanned

@property (nonatomic, readonly) BOOL blinkAnimationOnResult

Declared In

ALScanFeedbackConfig.h

  beepOnResult

Indicate whether a device beep sound is played when an object is successfully scanned

@property (nonatomic, readonly) BOOL beepOnResult

Declared In

ALScanFeedbackConfig.h

  vibrateOnResult

Indicate whether the device will vibrate briefly when an object is successfully scanned

@property (nonatomic, readonly) BOOL vibrateOnResult

Declared In

ALScanFeedbackConfig.h

  feedbackStyleStr

The string representation of the feedback style

@property (nonatomic, readonly) NSString *feedbackStyleStr

Declared In

ALScanFeedbackConfig.h

  animationStyleStr

The string representation of the feedback animation style

@property (nonatomic, readonly) NSString *animationStyleStr

Declared In

ALScanFeedbackConfig.h

– initWithJSONDictionary:error:

Initializes an ALScanFeedbackConfig with an NSDictionary representing the JSON config object

- (instancetype _Nullable)initWithJSONDictionary:(NSDictionary *_Nonnull)JSONDictionary error:(NSError *_Nullable *_Nullable)error

Parameters

JSONDictionary

an NSDictionary representing the JSON config object
error

NSError object which is filled with appropriate information when initialization fails

Return Value

an instance of ALScanFeedbackConfig

Declared In

ALScanFeedbackConfig.h

+ withJSONDictionary:

Creates an ALScanFeedbackConfig with an NSDictionary representing the JSON config object

+ (ALScanFeedbackConfig *_Nullable)withJSONDictionary:(NSDictionary *)JSONDictionary

Parameters

JSONDictionary

NSDictionary representing the JSON config object

Return Value

an instance of ALScanFeedbackConfig

Declared In

ALScanFeedbackConfig.h

+ defaultScanFeedbackConfig

an instance of ALScanFeedbackConfig

+ (ALScanFeedbackConfig *)defaultScanFeedbackConfig

Return Value

an instance of ALScanFeedbackConfig

Declared In

ALScanFeedbackConfig.h

– initWithFeedbackStyle:animationStyle:animationDuration:strokeWidth:strokeColor:fillColor:cornerRadius:redrawTimeout:beepOnResult:blinkAnimationOnResult:vibrateOnResult:

- (instancetype)initWithFeedbackStyle:(ALScanFeedbackStyle)feedbackStyle animationStyle:(ALFeedbackAnimationStyle)animationStyle animationDuration:(NSInteger)animationDuration strokeWidth:(NSInteger)strokeWidth strokeColor:(NSString *_Nullable)strokeColor fillColor:(NSString *_Nullable)fillColor cornerRadius:(NSInteger)cornerRadius redrawTimeout:(NSInteger)redrawTimeout beepOnResult:(BOOL)beepOnResult blinkAnimationOnResult:(BOOL)blinkAnimationOnResult vibrateOnResult:(BOOL)vibrateOnResult

+ withFeedbackStyle:animationStyle:animationDuration:strokeWidth:strokeColor:fillColor:cornerRadius:redrawTimeout:beepOnResult:blinkAnimationOnResult:vibrateOnResult:

+ (ALScanFeedbackConfig *)withFeedbackStyle:(ALScanFeedbackStyle)feedbackStyle animationStyle:(ALFeedbackAnimationStyle)animationStyle animationDuration:(NSInteger)animationDuration strokeWidth:(NSInteger)strokeWidth strokeColor:(NSString *_Nullable)strokeColor fillColor:(NSString *_Nullable)fillColor cornerRadius:(NSInteger)cornerRadius redrawTimeout:(NSInteger)redrawTimeout beepOnResult:(BOOL)beepOnResult blinkAnimationOnResult:(BOOL)blinkAnimationOnResult vibrateOnResult:(BOOL)vibrateOnResult