Atalasoft MobileImage API Reference
Classes | Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
com.kofax.mobile.sdk.capture.id.IdWorkflowActivity Class Reference
Inheritance diagram for com.kofax.mobile.sdk.capture.id.IdWorkflowActivity:
com.kofax.mobile.sdk.capture.WorkflowActivity< T extends IParameters >

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 ()
 
String decodeBarcodeResult (String data)
 
- Public Member Functions inherited from com.kofax.mobile.sdk.capture.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 ()
 
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 com.kofax.mobile.sdk.capture.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 com.kofax.mobile.sdk.capture.WorkflowActivity< T extends IParameters >
boolean isOdeSupported ()
 
void onCreate (Bundle savedInstanceState)
 
void handleException (final Exception 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 extractionType set to 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:

Member Function Documentation

String com.kofax.mobile.sdk.capture.id.IdWorkflowActivity.decodeBarcodeResult ( String  data)
inline
Class<? extends Activity> com.kofax.mobile.sdk.capture.id.IdWorkflowActivity.getCaptureActivityClass ( )
inline

Gets the specific capture activity for this workflow

Returns
IdCaptureActivity or IdCaptureBackActivity depending on parameters
String com.kofax.mobile.sdk.capture.id.IdWorkflowActivity.getDefaultProcessingString ( IdParameters  parameters)
inline

Gets the specific processing string for this workflow

CaptureData com.kofax.mobile.sdk.capture.id.IdWorkflowActivity.getDefaultReturnObject ( )
inline

Retrieves an empty ID object

Returns
Id
String com.kofax.mobile.sdk.capture.id.IdWorkflowActivity.getExceptionKey ( )
inline

Gets the specific exception key for this workflow

Returns
ID_EXCEPTION
Class<? extends Activity> com.kofax.mobile.sdk.capture.id.IdWorkflowActivity.getExtractActivityClass ( )
inline

Gets the specific extract activity for this workflow

Returns
IdExtractActivity
IdParameters com.kofax.mobile.sdk.capture.id.IdWorkflowActivity.getParametersInstance ( )
inline
String com.kofax.mobile.sdk.capture.id.IdWorkflowActivity.getParametersKey ( )
inline

Gets the specific parameter key for this workflow

Returns
ID_PARAMETERS
String com.kofax.mobile.sdk.capture.id.IdWorkflowActivity.getResultKey ( )
inline

Gets the specific result key for this workflow

Returns
ID_RESULTS
boolean com.kofax.mobile.sdk.capture.id.IdWorkflowActivity.isOdeSupported ( )
inlineprotected
void com.kofax.mobile.sdk.capture.id.IdWorkflowActivity.onActivityResult ( int  requestCode,
int  resultCode,
Intent  data 
)
inlineprotected
void com.kofax.mobile.sdk.capture.id.IdWorkflowActivity.onCreate ( Bundle  savedInstanceState)
inlineprotected

Member Data Documentation

final String com.kofax.mobile.sdk.capture.id.IdWorkflowActivity.ID_BARCODE_RESULTS = "_com.kofax.mobile.sdk.capture._id_barcode_results_"
static
final String com.kofax.mobile.sdk.capture.id.IdWorkflowActivity.ID_EXCEPTION = "_com.kofax.mobile.sdk.capture._id_exception_"
static
final String com.kofax.mobile.sdk.capture.id.IdWorkflowActivity.ID_PARAMETERS = "_com.kofax.mobile.sdk.capture._id_parameters_"
static
final String com.kofax.mobile.sdk.capture.id.IdWorkflowActivity.ID_RESULTS = "_com.kofax.mobile.sdk.capture._id_results_"
static

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