Atalasoft MobileImage API Reference
kfxKOEIDExtractor.h
Go to the documentation of this file.
1 //
2 // kfxKOEIDExtractor.h
3 // kfxLibEngines
4 //
5 // Copyright (c) 2014-2016 Kofax. All rights reserved. Kofax Confidential.
6 // Unauthorized use, duplication, or distribution, or disclosure is strictly prohibited.
7 //
8 
9 #import <Foundation/Foundation.h>
10 
13 
15 
20 @interface KFXIDExtractionResult : NSObject
21 
23 
28 @property (nonatomic, assign) BOOL isBarcodeRead;
29 
31 
36 @property (nonatomic, assign) BOOL isOcrRead;
37 
39 
48 @property (nonatomic, assign) float documentVerificationConfidenceRating;
49 
51 
58 @property (nonatomic, strong) NSArray* fields;
59 
60 @end
61 
63 
66 @protocol kfxKOEIDExtractorDelegate <NSObject>
67 
68 @required
69 
71 
83 - (void)extractionResult:(KFXIDExtractionResult*)result frontError:(NSError*)frontError backError:(NSError*)backError;
84 
85 @end
86 
87 
89 
115 @interface kfxKOEIDExtractor : NSObject
116 
118 
123 @property (nonatomic, weak) id<kfxKOEIDExtractorDelegate> delegate;
124 
125 
127 
134 - (instancetype)initWithProjectProvider:(id<KFXProjectProviderProtocol>)projectProvider;
135 
137 
147 - (void)extract:(KFXIDExtractionParameters*)parameters;
148 
150 
157 - (void)cancelExtraction;
158 
159 @end
ID exraction parameters object.
Definition: KFXIDExtractionParameters.h:39
BOOL isBarcodeRead
Barcode read success indicator.
Definition: kfxKOEIDExtractor.h:28
BOOL isOcrRead
OCR success indicator.
Definition: kfxKOEIDExtractor.h:36
The ID Extractor Class.
Definition: kfxKOEIDExtractor.h:115
Project Provider protocol.
Definition: KFXProjectProviderProtocol.h:14
NSArray * fields
An array of extracted fields.
Definition: kfxKOEIDExtractor.h:58
float documentVerificationConfidenceRating
ID verification confidence rating.
Definition: kfxKOEIDExtractor.h:48
ID Extraction Result.
Definition: kfxKOEIDExtractor.h:20
ID Extraction Protocol.
Definition: kfxKOEIDExtractor.h:66
Untitled Document © 2016 Atalasoft, Inc., 116 Pleasant St, Suite 321, Easthampton, MA 01027, U.S.A. All rights reserved. Use is subject to license terms.