Kofax Mobile SDK API Reference
Class Methods | Properties | List of all members
kfxIDCaptureParameters Class Reference

The ID capture view controller parameters. More...

#import <kfxIDCaptureParameters.h>

Inheritance diagram for kfxIDCaptureParameters:
kfxIParameters

Class Methods

(NSString *) + projectNameForState:
 ID project name. More...
 

Properties

kfxIDSide idSide
 An ID side value that determines ID detection functionality. More...
 
kfxIDDatareverseSideID
 Data for reverse side of the ID. More...
 
kfxIDStatestate
 A value that determines state. More...
 
- Properties inherited from kfxIParameters
kfxLookAndFeelParameterslookAndFeelParameters
 Look and feel parameters object. More...
 
kfxProcessingParametersprocessingParameters
 Processing parameters object. More...
 
kfxExtractionParametersextractionParameters
 Extraction parameters object. More...
 

Detailed Description

The ID capture view controller parameters.

Encapsulates all parameters related to ID capture, processing and extraction.
Default values for following parameters are differ with base classes:

See also
kfxIParameters

Method Documentation

+ (NSString*) projectNameForState: (kfxIDState *)  state

ID project name.

Allows to get specific for state project name for asset downloading.

Parameters
state- ID state.
Returns
project name.
See also
kfxIDState

Property Documentation

- (kfxIDSide) idSide
readwritenonatomicassign

An ID side value that determines ID detection functionality.

The supported modes are: kfxIDSide_Front: Front ID side. kfxIDSide_Back: Back ID side.

The default value is kfxIDSide_Front.

See also
kfxIDSide
- (kfxIDData*) reverseSideID
readwritenonatomicstrong

Data for reverse side of the ID.

This data will be used for extraction along with the image for the current side of the ID. The field is used when capturing both sides of the ID.

See also
kfxIDData
- (kfxIDState*) state
readwritenonatomiccopy

A value that determines state.

This value is used for the extraction.

Specify one of the available values from kfxIDState predefines. The default value is [kfxIDState NotSpecified]. For this value extractor assumes the region is United States.

See also
kfxIDState

The documentation for this class was generated from the following file:
Untitled Document © 2018 Kofax, Inc. All rights reserved. Use is subject to license terms.