Atalasoft MobileImage API Reference
Properties | List of all members
kfxExtractionParameters Class Reference

The data extraction parameters class. More...

#import <kfxExtractionParameters.h>

Inheritance diagram for kfxExtractionParameters:

Properties

kfxExtractionType extractionType
 An extraction type value. More...
 
NSString * serverURL
 A string value that determines extraction server URL. More...
 
kfxExtractionCredentialscredentials
 Extraction credentials object. More...
 
id< KFXProjectProviderProtocolprojectProvider
 A project provider instance. More...
 

Detailed Description

The data extraction parameters class.

The parameters object allows to customize image data extraction functionality. The behavior and default values for some parameters could vary cross capture view controllers and details are specified in target document capture view controller parameters class.

See also
kfxIParameters

Property Documentation

- (kfxExtractionCredentials*) credentials
readwritenonatomiccopy

Extraction credentials object.

A property to get and set kfxExtractionCredentials object. The default value is nil.

Credentials are applicable for KTA server only.

See also
kfxExtractionCredentials
- (kfxExtractionType) extractionType
readwritenonatomicassign

An extraction type value.

The supported modes are: kfxExtractionType_RTTI: extraction should be performed on RTTI server. kfxExtractionType_KTA: extraction should be performed on KTA server. kfxExtractionType_OnDevice: extraction should be performed on device. Supported only for IDs and passports. kfxExtractionType_Off: extraction is disabled. Default value is kfxExtractionType_RTTI.

When performing extraction (value set not to kfxExtractionType_Off), image processing is required for successful extraction.

See also
kfxProcessingParameters
- (id<KFXProjectProviderProtocol>) projectProvider
readwritenonatomicstrong

A project provider instance.

A property to get and set project provider. The default value is nil.

Applicable for on-device extraction only.

See also
KFXProjectProviderProtocol
- (NSString*) serverURL
readwritenonatomiccopy

A string value that determines extraction server URL.

Specify the server URL in the following format: "http(s)://yourserver.com". To use the default server URL, set this property to nil. The default value used depends on the target capture view controller. The default value is nil.


The documentation for this class was generated from the following file:
Untitled Document © 2017 Atalasoft, Inc., 116 Pleasant St, Suite 321, Easthampton, MA 01027, U.S.A. All rights reserved. Use is subject to license terms.