KFXIDExtractionParameters.h

Go to the documentation of this file.

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

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

@class kfxKEDImage;
@class kfxKEDBarcodeResult;


typedef NS_ENUM(NSInteger, KFXIDType)
{
    KFXIDType_ID,
    KFXIDType_Passport
};


@interface KFXIDExtractionParameters : NSObject


@property (nonatomic, assign, readonly) KFXIDType type;


@property (nonatomic, assign, readonly) kfxKOEIDRegion region DEPRECATED_ATTRIBUTE;


@property (nonatomic, strong, readonly) NSString* projectName;


@property (nonatomic, strong, readonly) kfxKEDImage* frontImage;


@property (nonatomic, strong, readonly) kfxKEDImage* backImage;


@property (nonatomic, strong, readonly) NSArray<kfxKEDBarcodeResult*>* frontBarcodes;


@property (nonatomic, strong, readonly) NSArray<kfxKEDBarcodeResult*>* backBarcodes;


@property (nonatomic, assign, readonly) BOOL isProcessed;


@property (nonatomic, assign, readonly) BOOL extractFaceImage;


@property (nonatomic, assign, readonly) BOOL extractSignatureImage;


+ (NSString*)projectNameForRegion:(kfxKOEIDRegion)region idType:(KFXIDType)type;


+ (void)regionForProject:(NSString*)projectName region:(kfxKOEIDRegion*)region idType:(KFXIDType*)type;


- (instancetype)initWithType:(KFXIDType)type region:(kfxKOEIDRegion)region frontImage:(kfxKEDImage*)frontImage frontBarcodes:(NSArray<kfxKEDBarcodeResult*>*)frontBarcodes backImage:(kfxKEDImage*)backImage backBarcodes:(NSArray<kfxKEDBarcodeResult*>*)backBarcodes isProcessed:(BOOL)isProcessed DEPRECATED_ATTRIBUTE;


- (instancetype)initWithType:(KFXIDType)type projectName:(NSString*)projectName frontImage:(kfxKEDImage*)frontImage frontBarcodes:(NSArray<kfxKEDBarcodeResult*>*)frontBarcodes backImage:(kfxKEDImage*)backImage backBarcodes:(NSArray<kfxKEDBarcodeResult*>*)backBarcodes isProcessed:(BOOL)isProcessed;


- (instancetype)initWithType:(KFXIDType)type projectName:(NSString*)projectName frontImage:(kfxKEDImage*)frontImage frontBarcodes:(NSArray<kfxKEDBarcodeResult*>*)frontBarcodes backImage:(kfxKEDImage*)backImage backBarcodes:(NSArray<kfxKEDBarcodeResult*>*)backBarcodes isProcessed:(BOOL)isProcessed extractFaceImage:(BOOL)extractFaceImage extractSignatureImage:(BOOL)extractSignatureImage;

@end