Kofax Mobile SDK API Reference
Public Member Functions | List of all members
ServerExtractionParameters Class Reference

Public Member Functions

 ServerExtractionParameters (String serverUrl, List< Image > images, List< byte[]> imageBytes, CertificateValidatorListener certificateValidationListener, HashMap< String, String > parameters, TimeOutParameters timeOutParameters)
 
String getServerUrl ()
 
List< ImagegetImages ()
 
List< byte[]> getImageBytes ()
 
CertificateValidatorListener getCertificateValidationListener ()
 
HashMap< String, String > getParameters ()
 
TimeOutParameters getTimeOutParameters ()
 

Detailed Description

Parameter holder object for server extraction.

Images (or) ImageBytes should be present for extraction, If both are present then the priority will be given to ImageBytes

Constructor & Destructor Documentation

ServerExtractionParameters ( String  serverUrl,
List< Image images,
List< byte[]>  imageBytes,
CertificateValidatorListener  certificateValidationListener,
HashMap< String, String >  parameters,
TimeOutParameters  timeOutParameters 
)

Construct a new ServerExtractionParameters object

If the connection is RTTI then the 'x' parameters need to be sent as key-value pairs using the java.util.HashMap. If the connection is KTA, below are the recommendations.

The KTA supports the following key-value pairs: "DocumentName","DocumentTypeId","FilePath","FolderId","FolderTypeId","ReturnFullTextOcr" in the Documents section. "ReturnAllFields" is set to true always and hence there is no support for the key "RunTimeFields", "sessionId" - retrieved from successful login to KTA server "processIdentityName" - the name of the process identity. (For example, KofaxMobileIDSync) "StartDate" and "StoreFolderAndDocuments" are supported.

KTA API : you can add a key "syncProcessMap" which takes a boolean value to specify the KTA API to be used. Two main APIs are supported i.e. CreateJobSyncWithDocuments and CreateJobWithDocumentsAndProgress2. If the value is set to true, "CreateJobSyncWithDocuments" is used and if it is set to false "CreateJobWithDocumentsAndProgress2" is used. On a general note, extraction uses "CreateJobSyncWithDocuments". So it is recommended to set this value true for extraction. If this key is not added, a default true value is assumed.

If the response from the server needs to contain certain variables you can set the key "variablesToReturn" and value as json array in java.lang.String format.

JSONArray _jsonArray = new JSONArray();
HashMap _hashMap = new HashMap();
_hashMap.put("sessionId", "xxx-xxx-xxx");
_hashMap.put("variablesToReturn", _jsonArray.toString());
Parameters
serverUrlThe URL of the Server (cannot be null).
imagesList of Image Objects.
imageBytesList of ImageBytes.
certificateValidationListenerThis Interface defines a method that you may implement for custom certificate pinning logic.
parametersThis contains the parameters that are to be sent in the request to server.
timeOutParametersThis contains time out parameters. -

Member Function Documentation

CertificateValidatorListener getCertificateValidationListener ( )
List<byte[]> getImageBytes ( )
List<Image> getImages ( )
HashMap<String, String> getParameters ( )
String getServerUrl ( )
TimeOutParameters getTimeOutParameters ( )

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.