kfxKOEIDExtractor.h

Go to the documentation of this file.

//
//  kfxKOEIDExtractor.h
//  kfxLibEngines
//
//  Copyright (c) 2014-2017 Kofax. All rights reserved. Kofax Confidential.
//  Unauthorized use, duplication, or distribution, or disclosure is strictly prohibited.
//

#import <Foundation/Foundation.h>
#import "kfxKOEImageField.h"

@class KFXIDExtractionParameters;
@class kfxKEDClassificationResult;
@class kfxKEDImage;
@protocol KFXProjectProviderProtocol;

extern NSString* const KFXAdditionalErrorsKey;


@interface KFXIDExtractionResult : NSObject


@property (nonatomic, assign) BOOL isBarcodeRead;


@property (nonatomic, assign) BOOL isOcrRead;


@property (nonatomic, assign) float documentVerificationConfidenceRating;


@property (nonatomic, strong) NSArray* fields;


@property (nonatomic, strong) kfxKEDClassificationResult* frontClassification;


@property (nonatomic, strong) kfxKEDClassificationResult* backClassification;


@property (nonatomic, strong) kfxKOEImageField* faceImageField;


@property (nonatomic, strong) kfxKOEImageField* signatureImageField;

@end


@protocol kfxKOEIDExtractorDelegate<NSObject>

@required


- (void)extractionResult:(KFXIDExtractionResult*)result frontError:(NSError*)frontError backError:(NSError*)backError;

@end



@protocol kfxKOEIDImageProcessingDelegate<NSObject>

@optional


- (void)frontProcessedImage:(kfxKEDImage*)processedImage;

@optional


- (void)backProcessedImage:(kfxKEDImage*)processedImage;

@end



@interface kfxKOEIDExtractor : NSObject


@property (nonatomic, weak) id<kfxKOEIDExtractorDelegate> delegate;



@property (nonatomic, weak) id<kfxKOEIDImageProcessingDelegate> imageProcessingDelegate;



- (instancetype)initWithProjectProvider:(id<KFXProjectProviderProtocol>)projectProvider;


- (void)extract:(KFXIDExtractionParameters*)parameters;


- (void)cancelExtraction;

@end