ALFlashConfig Class Reference

Inherits from NSObject
Conforms to ALJSONStringRepresentable
Declared in ALFlashConfig.h

Overview

Object configuring the flash module of the scan view

  flashMode

The flash mode

@property (nonatomic, readonly) ALFlashMode flashMode

Declared In

ALFlashConfig.h

  flashAlignment

The starting location of the flash button in the scan view

@property (nonatomic, readonly) ALFlashAlignment flashAlignment

Declared In

ALFlashConfig.h

  flashImage

If provided, the image shown for the flash

@property (nonatomic, readonly, nullable) UIImage *flashImage

Declared In

ALFlashConfig.h

  flashOffset

A point offset positioning the flash button. Used in conjunction with the flash alignment

@property (nonatomic, readonly) CGPoint flashOffset

Declared In

ALFlashConfig.h

– initWithJSONDictionary:error:

Initializes an ALFlashConfig with an NSDictionary representing the JSON config object

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

Parameters

JSONDictionary

NSDictionary representing the JSON config object
error

NSError object which is filled with appropriate information when initialization fails

Return Value

an instance of ALFlashConfig

Declared In

ALFlashConfig.h

+ withJSONDictionary:

Creates an ALFlashConfig with an NSDictionary representing the JSON config object

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

Parameters

JSONDictionary

NSDictionary representing the JSON config object

Return Value

an instance of ALFlashConfig

Declared In

ALFlashConfig.h

+ defaultFlashConfig

Creates an ALFlashConfig with default values, useful for further customization

+ (instancetype _Nonnull)defaultFlashConfig

Declared In

ALFlashConfig.h

– initWithFlashMode:flashAlignment:flashImageName:flashOffset:

Initializes an ALFlashConfig object

- (instancetype _Nullable)initWithFlashMode:(ALFlashMode)flashMode flashAlignment:(ALFlashAlignment)flashAlignment flashImageName:(NSString *_Nullable)flashImageName flashOffset:(CGPoint)flashOffset

Parameters

flashMode

The flash mode
flashAlignment

The starting location of the flash button in the scan view
flashImageName

If provided, the image shown for the flash
flashOffset

A point offset positioning the flash button. Used in conjunction with the flash alignment

Declared In

ALFlashConfig.h

+ withFlashMode:flashAlignment:flashImageName:flashOffset:

Creates an ALFlashConfig object

+ (ALFlashConfig *_Nullable)withFlashMode:(ALFlashMode)flashMode flashAlignment:(ALFlashAlignment)flashAlignment flashImageName:(NSString *_Nullable)flashImageName flashOffset:(CGPoint)flashOffset

Parameters

flashAlignment

The starting location of the flash button in the scan view
flashImageName

If provided, the image shown for the flash
flashOffset

A point offset positioning the flash button. Used in conjunction with the flash alignment

Declared In

ALFlashConfig.h