ALScanViewPlugin Class Reference

Inherits from	NSObject
Conforms to	ALScanViewPluginBase
Declared in	ALScanViewPlugin.h

Overview

Object connecting the ScanPlugin to the ScanView

`scanPlugin`

The scan plugin object associated with the scan view plugin

@property (nonatomic, readonly) ALScanPlugin *scanPlugin

Declared In

ALScanViewPlugin.h

`delegate`

The object being notified of any events encountered during scanning

@property (nonatomic, weak) id<ALScanViewPluginDelegate> delegate

Declared In

ALScanViewPlugin.h

`regionOfInterest`

The region within the image frame the scanner would specifically try to search for detectable objects

@property (nonatomic, assign) CGRect regionOfInterest

Declared In

ALScanViewPlugin.h

`isStarted`

Indicates whether the plugin composite has started or not

@property (nonatomic, readonly) BOOL isStarted

Declared In

ALScanViewPlugin.h

`pluginID`

Unique plugin ID for the scan view plugin

@property (nonatomic, readonly) NSString *pluginID

Declared In

ALScanViewPlugin.h

`– startWithError:`

Starts the plugin

- (BOOL)startWithError:(NSError *_Nullable *_Nullable)error

Parameters

`error`	if an error is encountered, this will be filled with the necessary information

Return Value

a boolean indicating whether or not the plugin was started successfully

Declared In

ALScanViewPlugin.h

`– stop`

Stops the plugin

- (void)stop

Declared In

ALScanViewPlugin.h

`children`

Children of the scan view plugin, if any

@property (nonatomic, readonly) NSArray<NSObject<ALScanViewPluginBase> *> *children

Declared In

ALScanViewPlugin.h

`scanViewPluginConfig`

The configuration object for the scan view plugin

@property (nonatomic, readonly) ALScanViewPluginConfig *scanViewPluginConfig

Declared In

ALScanViewPlugin.h

`– initWithConfig:error:`

Initializes an ALScanViewPlugin object with a configuration object

- (instancetype _Nullable)initWithConfig:(ALScanViewPluginConfig *_Nonnull)config error:(NSError *_Nullable *_Nullable)error

Parameters

`config`	an `ALScanViewPluginConfig` object
`error`	if initialization fails, this object would be set with the reason for the failure

Return Value

the ALScanViewPlugin object, or null

Declared In

ALScanViewPlugin.h

`– initWithJSONDictionary:error:`

Initializes an ALScanViewPlugin object with a configuration object

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

Parameters

`JSONDictionary`	a dictionary that encodes an `ALScanViewPluginConfig` object
`error`	if initialization fails, this object would be set with the reason for the failure

Return Value

the ALScanViewPlugin object

Declared In

ALScanViewPlugin.h