ALScanPluginConfig Class Reference

Inherits from	NSObject
Conforms to	ALJSONStringRepresentable
Declared in	ALScanPluginConfig.h

Overview

Configuration object for a ScanPlugin. This object contains an ALPluginConfig which contains configuration for a specific scanning use case.

`pluginID`

Plugin ID: each plugin should have a non-empty, and unique plugin string.

@property (nonatomic, readonly, copy) NSString *pluginID

Declared In

ALScanPluginConfig.h

`startScanDelay`

Amount of time, in milliseconds, where scanning is delayed upon starting a plugin. This might help with some cases where scanning happens too fast and the resulting image returned is blurry

@property (nonatomic, readonly) NSInteger startScanDelay

Declared In

ALScanPluginConfig.h

`cancelOnResult`

Stops the running plugin when a result is found. Defaults to true

@property (nonatomic, readonly) BOOL cancelOnResult

Declared In

ALScanPluginConfig.h

`pluginConfig`

The scanning use case specific configuration

@property (nonatomic, readonly) ALPluginConfig *pluginConfig

Declared In

ALScanPluginConfig.h

`– initWithPluginConfig:`

Initializes a scan plugin config with a plugin config

- (id)initWithPluginConfig:(ALPluginConfig *)pluginConfig

Parameters

`pluginConfig`	the plugin config object

Declared In

ALScanPluginConfig.h

`– initWithJSONDictionary:error:`

Initiailizes a scan plugin config with a JSON dictionary

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

Parameters

`JSONDictionary`	the JSON config object in NSDictionary form
`error`	NSError object which is filled with relevant error information in case initialization fails

Declared In

ALScanPluginConfig.h

`+ withPluginConfig:`

Convenience initializer taking an ALPluginConfig

+ (ALScanPluginConfig *)withPluginConfig:(ALPluginConfig *)pluginConfig

Parameters

`pluginConfig`	an `ALPluginConfig` object

Declared In

ALScanPluginConfig.h

`+ withJSONDictionary:`

Convenience initializer taking a JSON Dictionary object representing the config

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

Parameters

`JSONDictionary`	NSDictionary representing the ScanPluginConfig

Declared In

ALScanPluginConfig.h