Kofax Mobile SDK API Reference
Kofax Mobile SDK API Reference Documentation

Welcome

The Kofax Mobile SDK API Reference Guide for Android provides a detailed description of each class included in the Mobile SDK library. This guide assumes you have a detailed understanding of the development environments used to implement the APIs described here. This reference guide is designed to be used along with the Kofax Mobile SDK Developer's Guide as the primary reference documents for your development.

Main packages

Package Functionality
Capture Packaged Capture Experience API
Engines ImageProcessor, ImageClassifier, container for image (Image), image processing config (ImageProcessorConfiguration).
Results of operations performed like bar code data found (BarcodeResult), image classification results (ImageClassificationResult) or image quick analysis results (QuickAnalysisFeedback).
Bounding rectangle and tetragon.
Extract Server and On Device Extraction API
Logistics Interacting with Kofax Front Office and TotalAgility Servers (CaptureServer).
UserProfile class for server account information like user name and password.
Classes to store document data:
  Document, based on the definition of the document (DocumentType), contains an array of pages (Page) and methods to add and remove pages.
  Page, including an array of images (Image) associated with the page, and methods to add and remove images.
  Field, defining one field of data associated with the document, such as an address, account number or order selection. It references the FieldType object from which it was instantiated.
  FieldType, which defines the controls and limits of the field, such as the min and max range, and whether or not it is required.
UIControls

Classes and API associated with UI controls that you can add to your mobile application.
The image capture UI control (ImageCaptureView) captures images of documents that you want to include in the business process you design in your application. You should use it with appropriate capture experience class according to document types: common DocumentCaptureExperience or specialized CheckCaptureExperience, PassportCaptureExperience or FixedAspectRatioCaptureExperience
You can control the size, aspect ratio and design of a frame that represents a visual cue to the user that shows the size and orientation of the target page. Your user would then orient the camera or the document to line up with the frame so that the picture taken has the document correctly oriented.
Additional SelfieCaptureExperience guides the user to take a clear legible photo of a selfie.

The image review and edit control (ImgReviewEditCntrl) is intended to display images of documents used as part of your business flow. It includes a rectangle that you can control to allow your user to manually indicate the page boundary for a subsequent edit process using the image processor.
The Barcode UI capture control (BarCodeCaptureView) captures single barcode data when you hover over one with the live camera view.

Utilities

Licensing, error classes, SdkVersion, AppContextProvider, etc.

Asynchronous operations, events
The Kofax Mobile SDK not only includes classes to provide the API to properties and methods, but also several events and listeners for notifying you of progress or completion of asynchronous operations. Asynchronous operations include image processing, image classification, server communications through the logistics services, and image and barcode capture etc.
Some of the top level API classes are instantiated as regular instance objects by using a public constructor, but are restricted to having only one object instance active at any given time. These "one active at a time" objects include the image processor, the image classifier and the Server objects.
The Kofax Mobile SDK events are below. Mostly listener callbacks can be registered in each of the designated classes to receive these events.

Untitled Document © 2021 Kofax, Inc. All rights reserved. Use is subject to license terms.