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

Public Member Functions

Class<?extends Activity > getCaptureActivityClass ()
 
Class<?extends Activity > getExtractActivityClass ()
 
String getDefaultProcessingString (CheckParameters parameters)
 
CaptureData getDefaultReturnObject ()
 
String getParametersKey ()
 
String getResultKey ()
 
String getExceptionKey ()
 
CheckParameters getParametersInstance ()
 
- 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 CHECK_PARAMETERS = "_com.kofax.mobile.sdk.capture._check_parameters_"
 
static final String CHECK_RESULTS = "_com.kofax.mobile.sdk.capture._check_results_"
 
static final String CHECK_EXCEPTION = "_com.kofax.mobile.sdk.capture._check_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)
 
- 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 Check workflow specializes in capturing, processing and extracting data from a Check. To use this class, optionally construct new CheckParameters, modify those parameters for your use, then start an intent for this workflow:

CheckParameters _params = new CheckParameters(this);
Intent intent = new Intent(this, CheckWorkflowActivity.class);
_params.getLookAndFeelParameters().forceCaptureEnabled = true;
_params.getExtractionParameters().serverType = ExtractionParameters.ServerType.RTTI;
_params.getLookAndFeelParameters().galleryEnabled = true;
intent.putExtra(CheckWorkflowActivity.CHECK_PARAMETERS, _params);
startActivityForResult(intent, REQUEST_CODE);

Capturing both sides of a check

Checks 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 CheckWorkflowActivity for one side with extractionType set to OFF.
  2. Receive and store the check data available in the result Intent when Activity.onActivityResult gets called back.
  3. Start the CheckWorkflowActivity for the other side of the check with extraction enabled and CheckWorkflowActivity.reverseSideCheck set to the check 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

Class<? extends Activity> com.kofax.mobile.sdk.capture.check.CheckWorkflowActivity.getCaptureActivityClass ( )
inline

Gets the specific capture activity for this workflow

Returns
CheckCaptureActivity
String com.kofax.mobile.sdk.capture.check.CheckWorkflowActivity.getDefaultProcessingString ( CheckParameters  parameters)
inline

Gets the specific processing string for this workflow

CaptureData com.kofax.mobile.sdk.capture.check.CheckWorkflowActivity.getDefaultReturnObject ( )
inline

Retrieves an empty check object

Returns
Check
String com.kofax.mobile.sdk.capture.check.CheckWorkflowActivity.getExceptionKey ( )
inline

Gets the specific exception key for this workflow

Returns
CHECK_EXCEPTION
Class<? extends Activity> com.kofax.mobile.sdk.capture.check.CheckWorkflowActivity.getExtractActivityClass ( )
inline

Gets the specific extract activity for this workflow

Returns
CheckExtractActivity
CheckParameters com.kofax.mobile.sdk.capture.check.CheckWorkflowActivity.getParametersInstance ( )
inline
String com.kofax.mobile.sdk.capture.check.CheckWorkflowActivity.getParametersKey ( )
inline

Gets the specific parameter key for this workflow

Returns
CHECK_PARAMETERS
String com.kofax.mobile.sdk.capture.check.CheckWorkflowActivity.getResultKey ( )
inline

Gets the specific results key for this workflow

Returns
CHECK_RESULTS
void com.kofax.mobile.sdk.capture.check.CheckWorkflowActivity.onCreate ( Bundle  savedInstanceState)
inlineprotected

Member Data Documentation

final String com.kofax.mobile.sdk.capture.check.CheckWorkflowActivity.CHECK_EXCEPTION = "_com.kofax.mobile.sdk.capture._check_exception_"
static
final String com.kofax.mobile.sdk.capture.check.CheckWorkflowActivity.CHECK_PARAMETERS = "_com.kofax.mobile.sdk.capture._check_parameters_"
static
final String com.kofax.mobile.sdk.capture.check.CheckWorkflowActivity.CHECK_RESULTS = "_com.kofax.mobile.sdk.capture._check_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.