PassportWorkflowActivity Class Reference

Inheritance diagram for PassportWorkflowActivity:

Public Member Functions
Class<?extends Activity >	getCaptureActivityClass ()
Class<?extends Activity >	getExtractActivityClass ()
String	getDefaultProcessingString (PassportParameters parameters)
CaptureData	getDefaultReturnObject ()
String	getParametersKey ()
String	getResultKey ()
String	getExceptionKey ()
PassportParameters	getParametersInstance ()
Public Member Functions inherited from WorkflowActivity< T extends IParameters >
abstract Class<?extends Activity >	getCaptureActivityClass ()
abstract Class<?extends Activity >	getExtractActivityClass ()
abstract String	getDefaultProcessingString (T parameters)
abstract CaptureData	getDefaultReturnObject ()
abstract String	getParametersKey ()
abstract String	getResultKey ()
abstract String	getExceptionKey ()
abstract T	getParametersInstance ()
T	getParameters (Bundle savedInstanceState)

Static Public Attributes
static final String	PASSPORT_PARAMETERS = "_com.kofax.mobile.sdk.capture._passport_parameters_"
static final String	PASSPORT_RESULTS = "_com.kofax.mobile.sdk.capture._passport_results_"
static final String	PASSPORT_EXCEPTION = "_com.kofax.mobile.sdk.capture._passport_exception_"
Static Public Attributes inherited from WorkflowActivity< T extends IParameters >
static final String	CERTIFICATE_VALIDATOR_LISTENER

Protected Member Functions
void	onCreate (Bundle savedInstanceState)
boolean	isOdeSupported ()
Protected Member Functions inherited from WorkflowActivity< T extends IParameters >
boolean	isOdeSupported ()
void	onCreate (Bundle savedInstanceState)
void	handleException (final Throwable exc)
void	tryRestoreState (Bundle savedInstanceState)
void	onSaveInstanceState (Bundle outState)
void	onDestroy ()
void	onResume ()
void	captureImage ()
void	onActivityResult (int requestCode, int resultCode, Intent data)
void	clearBitmap (String imageId)

Detailed Description

The Passport workflow specializes in capturing, processing and extracting data from a passport. To use this class, optionally construct new PassportParameters, modify those parameters for your use, then start an intent for this workflow:

PassportParameters _params = new PassportParameters(this);
Intent intent = new Intent(this, PassportWorkflowActivity.class);
_params.getLookAndFeelParameters().forceCaptureEnabled = true;
_params.getLookAndFeelParameters().galleryEnabled = true;
intent.putExtra(PassportWorkflowActivity.PASSPORT_PARAMETERS, _params);
startActivityForResult(intent, REQUEST_CODE);
 

New permissions model introduced in Android M

Some functions won't be available until necessary permissions are granted by the user. It's up to the developer when to ask for permissions and whether or not to show a rationale — SDK doesn't do that.

Functions that require permissions:

• Capture requires CAMERA permission.
• Adding location data to captured images requires ACCESS_FINE_LOCATION permission.
• The gallery button requires READ_EXTERNAL_STORAGE permission.

Member Function Documentation

Class<? extends Activity> getCaptureActivityClass

(

)

String getDefaultProcessingString

(

PassportParameters

parameters

)

CaptureData getDefaultReturnObject

(

)

Retrieves an empty passport object

Returns

Passport

String getExceptionKey

(

)

Class<? extends Activity> getExtractActivityClass

(

)

PassportParameters getParametersInstance

(

)

String getParametersKey

(

)

String getResultKey

(

)

boolean isOdeSupported ( )

protected

void onCreate ( Bundle  savedInstanceState )

protected

Member Data Documentation

final String PASSPORT_EXCEPTION = "_com.kofax.mobile.sdk.capture._passport_exception_"

static

final String PASSPORT_PARAMETERS = "_com.kofax.mobile.sdk.capture._passport_parameters_"

static

final String PASSPORT_RESULTS = "_com.kofax.mobile.sdk.capture._passport_results_"

static

---

The documentation for this class was generated from the following file:

• PassportWorkflowActivity.java