ALIDScanPlugin Class Reference

Inherits from ALAbstractScanPlugin : NSObject
Declared in ALIDScanPlugin.h

Overview

The ALIDScanPlugin class declares the programmatic interface for an object that manages easy access to Anylines ID scanning mode..

Communication with the host application is managed with a delegate that conforms to ALIDScanPluginDelegate & ALInfoDelegate. The information that gets read is passed to the delegate with the help of of an ALIdentification object.

– initWithPluginID:licenseKey:delegate:idConfig:error:

The Constructor for the IDScanPlugin.

- (instancetype _Nullable)initWithPluginID:(NSString *_Nullable)pluginID licenseKey:(NSString *_Nonnull)licenseKey delegate:(id<ALIDPluginDelegate> _Nonnull)delegate idConfig:(ALIDConfig *_Nonnull)config error:(NSError *_Nullable *_Nullable)error

Parameters

pluginID

An unique pluginID to identify the results

licenseKey

The Anyline license key

delegate

The delegate to receive the results

config

The IDConfig object (DrivingLicense or MRZ)

error

The Error object if something fails

Return Value

Boolean indicating the success / failure of the call.

Declared In

ALIDScanPlugin.h

– init

- (instancetype _Nullable)init

  delegates

@property (nonatomic, strong, readonly) NSHashTable<ALIDPluginDelegate> *delegates

– addDelegate:

- (void)addDelegate:(id<ALIDPluginDelegate> _Nonnull)delegate

– removeDelegate:

- (void)removeDelegate:(id<ALIDPluginDelegate> _Nonnull)delegate

  idConfig

@property (nullable, nonatomic, strong, readonly) ALIDConfig *idConfig

– setIDConfig:error:

Sets a new ALIdentityDocumentConfig and returns an Error if something failed.

- (BOOL)setIDConfig:(ALIDConfig *_Nonnull)idConfig error:(NSError *_Nullable *_Nullable)error

Parameters

idConfig

The ALIDConfig to set

error

The Error object if something fails

Return Value

Boolean indicating the success / failure of the call.

Declared In

ALIDScanPlugin.h