ALScanResult Class Reference

Inherits from	NSObject
Conforms to	ALJSONStringRepresentable
Declared in	ALScanResult.h

Overview

Object containing details for a successful scan result

`blobKey`

Blob key uniquely identifying this scan

@property (nonatomic, readonly) NSString *blobKey

Declared In

ALScanResult.h

`pluginID`

ID of the plugin that was initialized for this scan

@property (nonatomic, readonly) NSString *pluginID

Declared In

ALScanResult.h

`fullSizeImage`

A full sized image taken from the device camera that the successful scan was based on

@property (nonatomic, readonly) UIImage *fullSizeImage

Declared In

ALScanResult.h

`croppedImage`

A cropped version of the image taken from the device consisting of the region shown on the cutout

@property (nonatomic, readonly) UIImage *croppedImage

Declared In

ALScanResult.h

`faceImage`

Image of detected facial photo, if any

@property (nonatomic, readonly, nullable) UIImage *faceImage

Declared In

ALScanResult.h

`pluginResult`

An ALPluginResult object which contains complete plugin-specific details regarding the scan result

@property (nonatomic, readonly) ALPluginResult *pluginResult

Declared In

ALScanResult.h

`resultDictionary`

The scan result in NSDictionary form

@property (nonatomic, readonly) NSDictionary *resultDictionary

Declared In

ALScanResult.h

`– initWithJSONDictionary:image:error:`

Initializes an ALScanResult with a suitably-structured dictionary, and the image associated with the scan result

- (instancetype _Nullable)initWithJSONDictionary:(NSDictionary *)resultJSON image:(UIImage *)image error:(NSError *_Nullable *_Nullable)error

Parameters

`resultJSON`	the `NSDictionary` that encapsulates the scan result data
`image`	a `UIImage` of the scan that led to this result
`error`	error information that is filled when initialization fails

Return Value

the ALScanResult object, if no error is encountered, otherwise null

Declared In

ALScanResult.h

`– initWithScanResultEvent:`

Initializes an ALScanResult with an scan result-related ALEvent object

- (instancetype _Nullable)initWithScanResultEvent:(ALEvent *)event

Parameters

`event`	an `ALEvent` object containing details about the scan result

Return Value

the ALScanResult object

Declared In

ALScanResult.h

`+ withScanResultEvent:`

Creates an ALScanResult with an scan result-related ALEvent object

+ (ALScanResult *_Nullable)withScanResultEvent:(ALEvent *)event

Parameters

`event`	an `ALEvent` object containing details about the scan result

Return Value

the ALScanResult object

Declared In

ALScanResult.h