IdWorkflowActivity Class Reference

Inheritance diagram for IdWorkflowActivity:

Public Member Functions
Class<?extends Activity >	getCaptureActivityClass ()
Class<?extends Activity >	getExtractActivityClass ()
String	getDefaultProcessingString (IdParameters parameters)
CaptureData	getDefaultReturnObject ()
String	getParametersKey ()
String	getResultKey ()
String	getExceptionKey ()
IdParameters	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	ID_PARAMETERS = "_com.kofax.mobile.sdk.capture._id_parameters_"
static final String	ID_RESULTS = "_com.kofax.mobile.sdk.capture._id_results_"
static final String	ID_BARCODE_RESULTS = "_com.kofax.mobile.sdk.capture._id_barcode_results_"
static final String	ID_EXCEPTION = "_com.kofax.mobile.sdk.capture._id_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 ()
void	onActivityResult (int requestCode, int resultCode, Intent data)
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 Id workflow specializes in capturing, processing and extracting data from an Id. To use this class, optionally construct new IdParameters, modify those parameters for your use, then start an intent for this workflow:

IdParameters _params = new IdParameters(this);
Intent intent = new Intent(this, IdWorkflowActivity.class);
_params.getLookAndFeelParameters().forceCaptureEnabled = true;
_params.getLookAndFeelParameters().galleryEnabled = true;
intent.putExtra(IdWorkflowActivity.ID_PARAMETERS, _params);
startActivityForResult(intent, REQUEST_CODE);
 

The reverse-side capture activity will capture a PDF417 barcode. You can retrieve the data extracted from the barcode from the return data:

protected void onActivityResult(int requestCode, int resultCode, Intent data) {
     if (data.hasExtra(IdWorkflowActivity.ID_BARCODE_RESULTS) {
         // Retrieve barcode data
         String barcodeData = data.getStringExtra(IdWorkflowActivity.ID_BARCODE_RESULTS);
         // ...
     }
}
 

Capturing both sides of an Id

Ids have important information on both sides. For improved accuracy, data extraction should be performed for both sides during the same session. To achieve that follow these steps:

1. Start the IdWorkflowActivity for one side with call of setExtractionType (ExtractionType.OFF).
2. Receive and store the Id data available in the result Intent when Activity.onActivityResult gets called back.
3. Start the IdWorkflowActivity for the other side of the Id with extraction enabled and IdWorkflowActivity.reverseSideId set to the Id data from the step 2.

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

(

)

Gets the specific capture activity for this workflow

Returns

IdCaptureActivity or IdCaptureBackActivity depending on parameters

String getDefaultProcessingString

(

IdParameters

parameters

)

Gets the specific processing string for this workflow

CaptureData getDefaultReturnObject

(

)

Retrieves an empty ID object

Returns

Id

String getExceptionKey

(

)

Gets the specific exception key for this workflow

Returns

ID_EXCEPTION

Class<? extends Activity> getExtractActivityClass

(

)

Gets the specific extract activity for this workflow

Returns

IdExtractActivity

IdParameters getParametersInstance

(

)

String getParametersKey

(

)

Gets the specific parameter key for this workflow

Returns

ID_PARAMETERS

String getResultKey

(

)

Gets the specific result key for this workflow

Returns

ID_RESULTS

boolean isOdeSupported ( )

protected

void onActivityResult ( int  requestCode, int  resultCode, Intent  data  )

protected

void onCreate ( Bundle  savedInstanceState )

protected

Member Data Documentation

final String ID_BARCODE_RESULTS = "_com.kofax.mobile.sdk.capture._id_barcode_results_"

static

final String ID_EXCEPTION = "_com.kofax.mobile.sdk.capture._id_exception_"

static

final String ID_PARAMETERS = "_com.kofax.mobile.sdk.capture._id_parameters_"

static

final String ID_RESULTS = "_com.kofax.mobile.sdk.capture._id_results_"

static

---

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

• IdWorkflowActivity.java