Kofax Mobile SDK API Reference
|
ID exraction parameters object. More...
#import <KFXIDExtractionParameters.h>
Instance Methods | |
(instancetype) | - initWithType:region:frontImage:frontBarcodes:backImage:backBarcodes:isProcessed: |
Constructor. More... | |
(instancetype) | - initWithType:projectName:frontImage:frontBarcodes:backImage:backBarcodes:isProcessed: |
Constructor. More... | |
(instancetype) | - initWithType:projectName:frontImage:frontBarcodes:backImage:backBarcodes:isProcessed:extractFaceImage:extractSignatureImage: |
Constructor. More... | |
Class Methods | |
(NSString *) | + projectNameForRegion:idType: |
Converter method. More... | |
(void) | + regionForProject:region:idType: |
Converter method. More... | |
Properties | |
KFXIDType | type |
ID type parameter. More... | |
kfxKOEIDRegion region | DEPRECATED_ATTRIBUTE |
Region parameter. More... | |
NSString * | projectName |
Project name parameter. More... | |
kfxKEDImage * | frontImage |
Front image parameter. More... | |
kfxKEDImage * | backImage |
Back image parameter. More... | |
NSArray< kfxKEDBarcodeResult * > * | frontBarcodes |
Front barcode array parameter. More... | |
NSArray< kfxKEDBarcodeResult * > * | backBarcodes |
Back barcode array parameter. More... | |
BOOL | isProcessed |
Is processed flag. More... | |
BOOL | extractFaceImage |
Extract face flag. More... | |
BOOL | extractSignatureImage |
Extract signature flag. More... | |
ID exraction parameters object.
This object represents parameters for ID extractor.
Initialization: [KFXIDExtractionParameters new] (or [[KFXIDExtractionParameters alloc] init]) - default constructor, sets parameters to default values. Not a valid object to be sent to the extractor.
KFXIDExtractionParameters* params = [[KFXIDExtractionParameters alloc] initWithType:region:frontImage:frontBarcodes:backImage:backBarcodes:isProcessed]] - parameters will be initialized with provided type, region, front image, front barcodes, back image, back barcodes, 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 | |
Constructor.
This method allows to specify front image, front barcodes, back image, back barcode, ID type, projectName and isProcessed flag indicating whether images are processed or not.
type | - ID type. |
projectName | - project name. |
frontImage | - front image. |
frontBarcodes | - front side barcodes. |
backImage | - back image. |
backBarcodes | - back side barcodes. |
isProcessed | - front/back image processed indicator. |
- (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 | |
Constructor.
This method allows to specify front image, front barcodes, back image, back barcode, ID type, projectName, isProcessed flag, extracFaceImage flag, and extractSignatureImage flag.
type | - ID type. |
projectName | - project name. |
frontImage | - front image. |
frontBarcodes | - front side barcodes. |
backImage | - back image. |
backBarcodes | - back side barcodes. |
isProcessed | - front/back image processed indicator. |
extractFaceImage | - whether or not identification photo extraction will be attempted. |
extractSignatureImage | - whether or not signature image extraction will be attempted. |
- (instancetype) initWithType: | (KFXIDType) | type | |
region: | (kfxKOEIDRegion) | region | |
frontImage: | (kfxKEDImage *) | frontImage | |
frontBarcodes: | (NSArray< kfxKEDBarcodeResult * > *) | frontBarcodes | |
backImage: | (kfxKEDImage *) | backImage | |
backBarcodes: | (NSArray< kfxKEDBarcodeResult * > *) | backBarcodes | |
isProcessed: | (BOOL) | DEPRECATED_ATTRIBUTE | |
Constructor.
This method allows to specify front image, front barcodes, back image, back barcode, ID type, region and isProcessed flag indicating whether images are processed or not.
type | - ID type. |
region | - ID region. |
frontImage | - front image. |
frontBarcodes | - front side barcodes. |
backImage | - back image. |
backBarcodes | - back side barcodes. |
isProcessed | - front/back image processed indicator. |
+ (NSString*) projectNameForRegion: | (kfxKOEIDRegion) | region | |
idType: | (KFXIDType) | type | |
Converter method.
This method converts provided region value and ID type to the corresponding project name.
region | - ID region. |
type | - ID type. |
+ (void) regionForProject: | (NSString *) | projectName | |
region: | (kfxKOEIDRegion *) | region | |
idType: | (KFXIDType *) | type | |
Converter method.
This method converts provided project name to the corresponding region and ID type. If project in invalid, region and type will be set to default values (kfxKOEIDRegion_US and KFXIDType_ID, respectively).
projectName | - ID project. |
region | - region value to be filled. |
type | - ID type value to be filled. |
|
readnonatomicstrong |
Back barcode array parameter.
Allows to get back barcodes.
Default value is nil.
|
readnonatomicstrong |
|
readnonatomicassign |
Region parameter.
Allows to get region parameter value.
Default value is kfxKOEIDRegion_US.
|
readnonatomicassign |
Extract face flag.
Allows to specify if identification photo extraction will be attempted.
Default value is NO.
|
readnonatomicassign |
Extract signature flag.
Allows to specify if signature image extraction will be attempted.
Default value is NO.
|
readnonatomicstrong |
Front barcode array parameter.
Allows to get front barcodes.
Default value is nil.
|
readnonatomicstrong |
|
readnonatomicassign |
Is processed flag.
Allows to specify if front/back image has already been processed prior to extraction.
Default value is NO.
|
readnonatomicstrong |
Project name parameter.
Allows to get projectName parameter value.
Default value is nil.
|
readnonatomicassign |