Kofax Mobile SDK API Reference
Classes | Public Member Functions | Public Attributes | List of all members
ExtractionParameters Class Reference
Inheritance diagram for ExtractionParameters:

Classes

enum  ExtractionType
 

Public Member Functions

 ExtractionParameters ()
 
ExtractionType getExtractionType ()
 
void setExtractionType (ExtractionType extractionType)
 
void setProjectProvider (Context context, IProjectProvider projectProvider)
 Sets a project provider instance. More...
 

Public Attributes

String serverUrl
 
ExtractionCredentials credentials = new ExtractionCredentials()
 

Detailed Description

The data extraction parameters class. The parameters object allows customization of image data extraction functionality.

See also
IParameters

Constructor & Destructor Documentation

Member Function Documentation

ExtractionType getExtractionType ( )

Gets the currently set extraction type parameter.

The default value is ExtractionType#RTTI

void setExtractionType ( ExtractionType  extractionType)

Sets the desired extraction type

Parameters
extractionType
void setProjectProvider ( Context  context,
IProjectProvider  projectProvider 
)

Sets a project provider instance.

The default value is null (the default project provider will be used).

Applicable for on-device extraction only.

Member Data Documentation

Extraction credentials object.

The default value is null. Credentials are applicable for KTA server type only.

String serverUrl

A string value that determines extraction server URL. Specify the server URL in format: "http(s)://yourserver.com/path_to_the_service_api".

To use the default value, leave this null. The default value depends on document type and ExtractionParameters#getExtractionType().


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.