Kofax Mobile SDK API Reference
kfxIDCaptureParameters.h
Go to the documentation of this file.
1 //
2 // API Reference
3 // kfxIDCaptureParameters.h
4 // Framework: MobileSDK
5 //
6 // Copyright (c) 2012 - 2017 Kofax. Use of this code is with permission pursuant to Kofax license terms.
7 
8 #import <MobileSDK/kfxIParameters.h>
9 #import <MobileSDK/kfxKOEIDRegion.h>
10 
11 @class kfxIDData;
12 
14 
17 typedef NS_ENUM (NSInteger, kfxIDSide)
18 {
21 };
23 
25 
28 @interface kfxIDState : NSObject <NSCopying>
29 
31 
38 @property (nonatomic, readonly, assign) kfxKOEIDRegion idRegion;
39 
41 
44 - (BOOL)isEqualToState:(kfxIDState*)otherState;
45 
46 @end
47 
49 
53 
55 
58 + (instancetype)NotSpecified;
59 
61 
64 + (instancetype)UnitedStates;
65 
67 
70 + (instancetype)Canada;
71 
73 
76 + (instancetype)AfricaOther;
77 
79 
82 + (instancetype)Cameroon;
83 
85 
88 + (instancetype)AsiaOther;
89 
91 
94 + (instancetype)China;
95 
97 
100 + (instancetype)India;
101 
103 
106 + (instancetype)Singapore;
107 
109 
112 + (instancetype)SouthKorea;
113 
115 
118 + (instancetype)Japan;
119 
121 
124 + (instancetype)AustraliaOther;
125 
127 
130 + (instancetype)KeyPass;
131 
133 
136 + (instancetype)EuropeOther;
137 
139 
142 + (instancetype)Albania;
143 
145 
148 + (instancetype)Germany;
149 
151 
154 + (instancetype)Lithuania;
155 
157 
160 + (instancetype)Luxembourg;
161 
163 
166 + (instancetype)LatinAmericaOther;
167 
169 
172 + (instancetype)Brazil;
173 
175 
178 + (instancetype)Ecuador;
179 
181 
184 + (instancetype)ElSalvador;
185 
187 
190 + (instancetype)Guatemala;
191 
193 
196 + (instancetype)StChristNevis;
197 
198 @end
200 
202 
210 @interface kfxIDCaptureParameters : kfxIParameters <NSCopying>
211 
213 
222 @property (nonatomic, assign) kfxIDSide idSide;
224 
226 
232 @property (nonatomic, strong) kfxIDData* reverseSideID;
233 
235 
243 @property (nonatomic, copy) kfxIDState* state;
244 
246 
254 + (NSString*)projectNameForState:(kfxIDState*)state;
256 @end
+[kfxIDState(kfxIDStateCreation) EuropeOther]
instancetype EuropeOther()
Other Europe state.
kfxKOEIDRegion
kfxKOEIDRegion
An enumeration containing the possible region values.
Definition: kfxKOEIDRegion.h:16
kfxIDSide_Back
Definition: kfxIDCaptureParameters.h:20
+[kfxIDState(kfxIDStateCreation) Cameroon]
instancetype Cameroon()
Cameroon state.
+[kfxIDState(kfxIDStateCreation) Singapore]
instancetype Singapore()
Singapore state.
+[kfxIDState(kfxIDStateCreation) India]
instancetype India()
India state.
kfxIDSide_Front
Definition: kfxIDCaptureParameters.h:19
+[kfxIDState(kfxIDStateCreation) KeyPass]
instancetype KeyPass()
Key Pass state.
kfxIDState::idRegion
kfxKOEIDRegion idRegion
ID region value.
Definition: kfxIDCaptureParameters.h:38
kfxIDSide
kfxIDSide
An enumeration containing the possible ID side values.
Definition: kfxIDCaptureParameters.h:17
+[kfxIDState(kfxIDStateCreation) UnitedStates]
instancetype UnitedStates()
United States state.
+[kfxIDState(kfxIDStateCreation) StChristNevis]
instancetype StChristNevis()
StChristNevis state.
kfxIDData
This object represents id document data.
Definition: kfxIDData.h:18
+[kfxIDState(kfxIDStateCreation) Guatemala]
instancetype Guatemala()
Guatemala state.
+[kfxIDState(kfxIDStateCreation) Albania]
instancetype Albania()
Albania state.
kfxIDCaptureParameters
The ID capture view controller parameters.
Definition: kfxIDCaptureParameters.h:210
+[kfxIDState(kfxIDStateCreation) Japan]
instancetype Japan()
Japan state.
+[kfxIDState(kfxIDStateCreation) Brazil]
instancetype Brazil()
Brazil state.
+[kfxIDState(kfxIDStateCreation) Germany]
instancetype Germany()
Germany state.
kfxIDState(kfxIDStateCreation)
The ID state creation category.
Definition: kfxIDCaptureParameters.h:52
kfxIParameters
The base class for capture view controller parameters.
Definition: kfxIParameters.h:18
+[kfxIDState(kfxIDStateCreation) Ecuador]
instancetype Ecuador()
Ecuador state.
+[kfxIDState(kfxIDStateCreation) NotSpecified]
instancetype NotSpecified()
NotSpecified state.
+[kfxIDState(kfxIDStateCreation) LatinAmericaOther]
instancetype LatinAmericaOther()
Other Latin America state.
+[kfxIDState(kfxIDStateCreation) AsiaOther]
instancetype AsiaOther()
Other Asia state.
+[kfxIDState(kfxIDStateCreation) ElSalvador]
instancetype ElSalvador()
ElSalvador state.
+[kfxIDState(kfxIDStateCreation) China]
instancetype China()
China state.
+[kfxIDState(kfxIDStateCreation) Canada]
instancetype Canada()
Canada state.
+[kfxIDState(kfxIDStateCreation) SouthKorea]
instancetype SouthKorea()
South Korea state.
kfxIDState
The ID state class.
Definition: kfxIDCaptureParameters.h:28
+[kfxIDState(kfxIDStateCreation) Lithuania]
instancetype Lithuania()
Lithuania state.
+[kfxIDState(kfxIDStateCreation) AustraliaOther]
instancetype AustraliaOther()
Other Australia state.
+[kfxIDState(kfxIDStateCreation) AfricaOther]
instancetype AfricaOther()
Other Africa state.
+[kfxIDState(kfxIDStateCreation) Luxembourg]
instancetype Luxembourg()
Luxembourg state.
Untitled Document © 2021 Kofax, Inc. All rights reserved. Use is subject to license terms.