Kofax Mobile SDK API Reference
Classes | Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
BillWorkflowActivity Class Reference
Inheritance diagram for BillWorkflowActivity:
WorkflowActivity< T extends IParameters >

Public Member Functions

Class<?extends Activity > getCaptureActivityClass ()
 
Class<?extends Activity > getExtractActivityClass ()
 
String getDefaultProcessingString (BillParameters parameters)
 
CaptureData getDefaultReturnObject ()
 
String getParametersKey ()
 
String getResultKey ()
 
String getExceptionKey ()
 
BillParameters 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 ()
 
getParameters (Bundle savedInstanceState)
 

Static Public Attributes

static final String BILL_PARAMETERS = "_com.kofax.mobile.sdk.capture.bill_parameters_"
 
static final String BILL_RESULTS = "_com.kofax.mobile.sdk.capture.bill_results_"
 
static final String BILL_EXCEPTION = "_com.kofax.mobile.sdk.capture.bill_exception_"
 
- Static Public Attributes inherited from WorkflowActivity< T extends IParameters >
static final String CERTIFICATE_VALIDATOR_LISTENER
 

Protected Member Functions

void onCreate (Bundle savedInstanceState)
 
- 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 Bill workflow specializes in capturing, processing and extracting data from a bill. To use this class, optionally construct new BillParameters, modify those parameters for your use, then start an intent for this workflow:

BillParameters _params = new BillParameters(this);
Intent intent = new Intent(this, BillWorkflowActivity.class);
_params.getLookAndFeelParameters().forceCaptureEnabled = true;
_params.getExtractionParameters().serverType = ExtractionParameters.ServerType.RTTI;
_params.getLookAndFeelParameters().galleryEnabled = true;
intent.putExtra(BillWorkflowActivity.BILL_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:

Member Function Documentation

Class<? extends Activity> getCaptureActivityClass ( )

Gets the specific capture activity for this workflow

Returns
BillCaptureActivity
String getDefaultProcessingString ( BillParameters  parameters)

Gets the specific processing string for this workflow

CaptureData getDefaultReturnObject ( )

Retrieves an empty bill object

Returns
Bill
String getExceptionKey ( )

Gets the specific exception key for this workflow

Returns
BILL_EXCEPTION
Class<? extends Activity> getExtractActivityClass ( )

Gets the specific extract activity for this workflow

Returns
BillExtractActivity
BillParameters getParametersInstance ( )
String getParametersKey ( )

Gets the specific parameter key for this workflow

Returns
BILL_PARAMETERS
String getResultKey ( )

Gets the specific result key for this workflow

Returns
BILL_RESULTS
void onCreate ( Bundle  savedInstanceState)
protected

Member Data Documentation

final String BILL_EXCEPTION = "_com.kofax.mobile.sdk.capture.bill_exception_"
static
final String BILL_PARAMETERS = "_com.kofax.mobile.sdk.capture.bill_parameters_"
static
final String BILL_RESULTS = "_com.kofax.mobile.sdk.capture.bill_results_"
static

The documentation for this class was generated from the following file:
Untitled Document © 2018 Kofax, Inc. All rights reserved. Use is subject to license terms.