ALPluginResult Class Reference

Inherits from NSObject
Declared in ALPluginResult.h

Overview

Describes all kinds of scan results Extension methods to work with ALPluginResult objects

Other Methods

  barcodeResult

@property (nonatomic, nullable, strong) ALBarcodeResult *barcodeResult

  blobKey

The blobKey (provided optionally, depending on the Anyline license settings)

@property (nonatomic, nullable, copy) NSString *blobKey

Declared In

ALPluginResult.h

  commercialTireIDResult

@property (nonatomic, nullable, strong) ALCommercialTireIDResult *commercialTireIDResult

  confidence

Provides a general confidence value between 0 and 100 if applicable. -1 if no confidence was calculated

@property (nonatomic, assign) NSInteger confidence

Declared In

ALPluginResult.h

  containerResult

@property (nonatomic, nullable, strong) ALContainerResult *containerResult

  cropRect

The rect information of the region that was processed within the image

@property (nonatomic, nullable, strong) ALCropRect *cropRect

Declared In

ALPluginResult.h

  japaneseLandingPermissionResult

@property (nonatomic, nullable, strong) ALJapaneseLandingPermissionResult *japaneseLandingPermissionResult

  licensePlateResult

@property (nonatomic, nullable, strong) ALLicensePlateResult *licensePlateResult

  meterResult

@property (nonatomic, nullable, strong) ALMeterResult *meterResult

  mrzResult

@property (nonatomic, nullable, strong) ALMrzResult *mrzResult

  ocrResult

@property (nonatomic, nullable, strong) ALOcrResult *ocrResult

  pluginID

The ID of the ScanPlugin that processed the result

@property (nonatomic, copy) NSString *pluginID

Declared In

ALPluginResult.h

  tinResult

@property (nonatomic, nullable, strong) ALTinResult *tinResult

  tireSizeResult

@property (nonatomic, nullable, strong) ALTireSizeResult *tireSizeResult

  universalIDResult

@property (nonatomic, nullable, strong) ALUniversalIDResult *universalIDResult

  vehicleRegistrationCertificateResult

@property (nonatomic, nullable, strong) ALVehicleRegistrationCertificateResult *vehicleRegistrationCertificateResult

  vinResult

@property (nonatomic, nullable, strong) ALVinResult *vinResult

+ 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 ALPluginResult object. Returns a null value if the string cannot be serialized into a valid object.

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

Parameters

JSONString

JSON string for the plugin result

Return Value

the ALPluginResult object, or null

Declared In

ALPluginResult+Extras.h

+ withJSONDictionary:

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

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

Parameters

JSONDictionary

JSON dictionary containing the plugin result

Return Value

the ALPluginResult object, or null

Declared In

ALPluginResult+Extras.h

– initWithJSONString:error:

Initializes an ALPluginResult object. 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 result

error

an error object which is set if an error during serialization is encountered

Return Value

the ALPluginResult object, or null

Declared In

ALPluginResult+Extras.h

– initWithJSONDictionary:error:

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

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

Parameters

JSONDictionary

JSON dictionary containing the plugin result

error

an error object which is set if an error during serialization is encountered

Return Value

the ALPluginResult object, or null

Declared In

ALPluginResult+Extras.h

– fieldList

Returns an ordered list of field objects pre-selected from the scan results, each a dictionary which contains the scanned value, the field name and its human-readable version. The list of fields included are based on what we believe are the most commonly-used; they are not guaranteed to remain the same with each release. The complete list of fields obtained from a scan can be found from the XXXResult property corresponding to your plugin use case (eg meterResult, ocrResult, etc).

- (NSArray<NSDictionary<NSString*,NSString*> *> *)fieldList

Declared In

ALPluginResult+Extras.h