ALPluginConfig Class Reference

Inherits from	NSObject
Declared in	ALPluginConfig.h

Overview

General configuration for scan plugins Extension methods to work with ALPluginConfig objects

Other Methods

`barcodeConfig`

@property (nonatomic, nullable, strong) ALBarcodeConfig *barcodeConfig

`cancelOnResult`

Sets whether or not to continue scanning once a result is found.

@property (nonatomic, nullable, strong) NSNumber *cancelOnResult

Declared In

ALPluginConfig.h

`commercialTireIDConfig`

@property (nonatomic, nullable, strong) ALCommercialTireIDConfig *commercialTireIDConfig

`containerConfig`

@property (nonatomic, nullable, strong) ALContainerConfig *containerConfig

`identifier`

Sets a name for the scan plugin.

@property (nonatomic, copy) NSString *identifier

Declared In

ALPluginConfig.h

`japaneseLandingPermissionConfig`

@property (nonatomic, nullable, strong) ALJapaneseLandingPermissionConfig *japaneseLandingPermissionConfig

`licensePlateConfig`

@property (nonatomic, nullable, strong) ALLicensePlateConfig *licensePlateConfig

`meterConfig`

@property (nonatomic, nullable, strong) ALMeterConfig *meterConfig

`mrzConfig`

@property (nonatomic, nullable, strong) ALMrzConfig *mrzConfig

`ocrConfig`

@property (nonatomic, nullable, strong) ALOcrConfig *ocrConfig

`startScanDelay`

Sets an initial time period where scanned frames are not processed as results.

@property (nonatomic, nullable, strong) NSNumber *startScanDelay

Declared In

ALPluginConfig.h

`startVariables`

Allows to fine-tune a list of options for plugins.

@property (nonatomic, nullable, copy) NSArray<ALStartVariable*> *startVariables

Declared In

ALPluginConfig.h

`tinConfig`

@property (nonatomic, nullable, strong) ALTinConfig *tinConfig

`tireSizeConfig`

@property (nonatomic, nullable, strong) ALTireSizeConfig *tireSizeConfig

`universalIDConfig`

@property (nonatomic, nullable, strong) ALUniversalIDConfig *universalIDConfig

`vehicleRegistrationCertificateConfig`

@property (nonatomic, nullable, strong) ALVehicleRegistrationCertificateConfig *vehicleRegistrationCertificateConfig

`vinConfig`

@property (nonatomic, nullable, strong) ALVinConfig *vinConfig

`+ fromJSON:encoding:error:`

+ (_Nullable instancetype)fromJSON:(NSString *)json encoding:(NSStringEncoding)encoding error:(NSError *_Nullable *)error

`+ fromData:error:`

+ (_Nullable instancetype)fromData:(NSData *)data error:(NSError *_Nullable *)error

`– toJSON:error:`

- (NSString *_Nullable)toJSON:(NSStringEncoding)encoding error:(NSError *_Nullable *)error

`– toData:`

- (NSData *_Nullable)toData:(NSError *_Nullable *)error

ALExtras Methods

`+ withJSONString:`

Constructs an ALPluginConfig. Returns a null value if the string cannot be serialized into a valid object.

+ (ALPluginConfig *_Nullable)withJSONString:(NSString *)JSONString

Parameters

`JSONString`	JSON string for the plugin configuration

Return Value

the ALPluginConfig object, or null

Declared In

ALPluginConfig+Extras.h

`+ withJSONDictionary:`

Constructs an ALPluginConfig from a suitably-structured dictionary. Returns a null value if the dictionary could not be serialized into a valid object.

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

Parameters

`JSONDictionary`	JSON dictionary containing the plugin configuration

Return Value

the ALPluginConfig object, or null

Declared In

ALPluginConfig+Extras.h

`– initWithJSONString:error:`

Initializes an ALPluginConfig. Returns a null value if the string cannot be serialized into a valid object.

- (instancetype _Nullable)initWithJSONString:(NSString *)JSONString error:(NSError *_Nullable *_Nullable)error

Parameters

`JSONString`	JSON string for the plugin configuration
`error`	an error object which is set if an error during serialization is encountered

Return Value

the ALPluginConfig object, or null

Declared In

ALPluginConfig+Extras.h

`– initWithJSONDictionary:error:`

Initializes an ALPluginConfig from a suitably-structured dictionary. If the dictionary could not be serialized into a valid object, the method returns null, and sets the error parameter.

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

Parameters

`JSONDictionary`	JSON dictionary containing the plugin configuration
`error`	an error object which is set if an error during serialization is encountered

Return Value

the ALPluginConfig object, or null

Declared In

ALPluginConfig+Extras.h