|
Kofax Mobile SDK API Reference
|
| ▼Ncom | |
| ▼Nkofax | |
| ▼Nkmc | |
| ▼Nken | |
| ►Nengines | |
| ►Ndata | |
| CBarCodeDataFormat | An enum that identifies the format of the bar code found |
| CBarCodeDirection | An enum that identifies the direction of the bar code found |
| CBarCodeResult | A single bar code found data item. This object is serializable |
| CBarCodeType | An enum that identifies the type of the bar code found |
| ►CBasicSettingsProfile | The BasicSettingsProfile specifies basic image processing options. This object is serializable |
| CCropType | An enum which identifies the crop type |
| COutputBitDepth | An enum which identifies the output bit depth |
| CRotateType | An enum which identifies the rotation type |
| CBoundingRect | The BoundingRect object holds four integer edge coordinates for a rectangle |
| ►CBoundingTetragon | The BoundingTetragon object holds four corner points for a tetragon. This object is serializable |
| CRotation | |
| CCheckDetectionResult | |
| CCheckDetectionSettings | |
| CCheckSide | |
| CDetectionResult | |
| CDetectionSettings | |
| CDocumentDetectionResult | |
| ►CDocumentDetectionSettings | |
| CDocumentEdgeDetection | An enumeration containing the possible edge detection algorithms |
| CFixedAspectRatioDetectionSettings | |
| CHorizontalGuidance | |
| CIGlareResult | This event is fired when an glare removal is done |
| ►CImage | The Image Object contains an in-memory and/or image file based representation of an image. This object is serializable |
| CFileIOEngine | An enum which optionally identifies the desired File I/O Engine used for reading and writing |
| CFileRestriction | An enum which specifies that ANSI X9.100-181 restrictions are needed for TIFF output |
| CImageFileRep | An enum which identifies the File Representation of the image file referenced by this Image Object |
| CImageMimeType | An enum which identifies the Mime Type of the image file referenced by this Image Object |
| CImageRep | An enum which identifies the Image Representation(s) included in this Image Object |
| COutputColor | An enum which identifies the output color desired for writing the bitmap to an image file |
| ►CImagePerfectionProfile | The ImagePerfectionProfile object encapsulates advanced image processing settings. This object is serializable |
| CUseDocumentDetectionBasedCrop | An enum used with the useDocumentDetectionBasedCrop property |
| CUseMRZPassportDetection | An enum used with the useMRZPassportDetection property |
| CUseTargetFrameCrop | An enum used with the useTargetFrameCrop property |
| CImageSource | |
| COrientationGuidance | |
| CPassportDetectionResult | |
| CPassportDetectionSettings | |
| CQuickAnalysisFeedback | The QuickAnalysisFeedback object contains the results of image quality checking using the doQuickAnalysis method of the ImageProcessor object. This object is serializable |
| CQuickAnalysisSettings | A configuration object for controlling the quick analysis image processing |
| CSelfieDetectionSettings | |
| CTurnGuidance | |
| CVerticalGuidance | |
| CZoomGuidance | |
| ►Nprocessing | |
| CColorDepth | |
| CCropType | |
| CDeskewType | |
| CDocumentDimensions | |
| CImageProcessorConfiguration | |
| CRotateType | |
| CTargetFrameCropType | |
| ►Nversion | |
| CKenVersion | |
| ►CBarCodeReader | The barcode recognition engine |
| CBarcodeReadCompleteEvent | |
| CBarcodeReadCompleteListener | |
| CDirection | |
| CSymbology | |
| CCheckDetector | |
| CDocumentDetector | |
| CGlareRemover | |
| CICheckDetector | |
| CIDocumentDetector | |
| CImageClassificationCompletedListener | The listener interface for receiving image classification completed events |
| CImageClassificationCompleteEvent | This event is raised in response to an image classification process |
| CImageClassificationResult | Results from classifying an image. This object is serializable |
| ►CImageClassifier | This class is used to classify images based on given configuration and model |
| CImageClassificationStatus | |
| ►CImageProcessor | The ImageProcessor is the image processing engine |
| CAnalysisCompleteEvent | An event that indicates that image quick analysis results are available |
| CAnalysisCompleteListener | The listener interface for receiving analysis complete events |
| CAnalysisProgressEvent | An event that indicates Image processing progress information is available |
| CAnalysisProgressListener | The listener interface for receiving Analysis Progress events |
| CImageOutEvent | An event that indicates a processed Image is available |
| CImageOutListener | The listener interface for receiving Image Out events |
| CProcessProgressEvent | An event that indicates Image processing progress information is available |
| CProcessProgressListener | The listener interface for receiving Process Progress events |
| CIPassportDetector | |
| CKENLogging | |
| CPassportDetector | |
| ▼Nklo | |
| ►Nlogistics | |
| ►Ndata | |
| CClassificationResult | Results from classifying a Document using an RTTI web service. This object is serializable |
| CDocument | The Document object is instantiated as a specific DocumentType. This object is serializable |
| ►CDocumentType | The DocumentType object is a model that describes the attributes of a document. This object is serializable |
| CSourceServer | An enum that identifies the source server from which the document was obtained |
| CDocumentTypeR | The DocumentTypeR Object is a model that describes the attributes of a document. This object is serializable |
| CField | The Field object is instantiated using a particular FieldType object and contains a value which confirms to that Field Type. This object is serializable |
| ►CFieldType | The FieldType Object is a model that describes the attributes of a field. This object is serializable |
| CDataType | An enum that defines the data type specified for this Field Type |
| ►CPage | There can be one or more Pages in a Document. This object is serializable |
| CSide | Indicates whether this Page is front or back of the sheet |
| CUserProfile | The UserProfile Object contains login credentials for a user |
| ►Nversion | |
| CKloVersion | |
| CKLOLogging | |
| ▼Nkui | |
| ►Nuicontrols | |
| ►Ncaptureanimations | |
| CCaptureExperience | This class is a base class for the DocumentCaptureExperience and CheckCaptureExperience, PassportCaptureExperience and FixedAspectRatioCaptureExperience |
| CCaptureExperienceCriteriaHolder | |
| ►CCaptureMessage | |
| CKUIMessageOrientation | |
| CCheckCaptureExperience | |
| CCheckCaptureExperienceCriteriaHolder | |
| CDocumentBaseCaptureExperience | |
| CDocumentBaseCaptureExperienceCriteriaHolder | |
| CDocumentCaptureExperience | |
| CDocumentCaptureExperienceCriteriaHolder | |
| CFixedAspectRatioCaptureExperience | |
| CFixedAspectRatioExperienceCriteriaHolder | |
| CPassportCaptureExperience | |
| CPassportCaptureExperienceCriteriaHolder | |
| CSelfieBaseCaptureExperience | |
| CSelfieCaptureExperience | |
| CSelfieCaptureExperienceCriteriaHolder | |
| ►Ndata | |
| CCameraType | This enum represents the camera type |
| CFlash | This enum represents the various camera flash settings |
| CGpsUsageLimits | |
| CGuidingLine | An enum representing the rendering and orientation of a guiding line for barcode capture |
| CImageCacheType | |
| CSearchDirection | An enum representing a direction or set of directions to search for barcodes |
| CSymbology | An enum representing a barcode symbology |
| ►Nversion | |
| CKuiVersion | |
| CAboutToCaptureListener | |
| CAutoFocusResultEvent | This event returns the result of the camera's attempt to auto focus |
| CAutoFocusResultListener | The listener interface for responding to camera focus events |
| CBarCodeCaptureView | |
| CBarCodeFoundEvent | An event that indicates a barcode has been found |
| CBarCodeFoundListener | The listener interface for receiving barcode events |
| ►CCameraInitializationEvent | This event fires when the camera is initialized or reinitialized |
| CCameraInitStatus | |
| CCameraInitializationFailedEvent | |
| CCameraInitializationFailedListener | |
| CCameraInitializationListener | The interface that is required to implement CameraInitializationEvent |
| CImageCapturedEvent | This event is fired when an image is successfully captured |
| CImageCapturedListener | The listener interface for image capture events |
| CImageCaptureView | |
| ►CImgReviewEditCntrl | |
| CLine_Style_Solid | An enum which lists the drawing style options the edge of the tetragon |
| CJustCapturedListener | |
| CKUILogging | |
| CLevelnessEvent | This event fires when the orientation of the device changes |
| CLevelnessListener | The interface that is required to implement StabilityDelayEvent |
| CLicenseCaptureView | |
| CLicenseFoundEvent | An event that indicates that a license was found |
| CLicenseFoundListener | The listener interface for receiving license found events |
| CPageDetectionEvent | An event that indicates a page was detected in the camera preview |
| CPageDetectionListener | |
| CPreviewCallbackListener | |
| CPreviewFrameEvent | |
| CStabilityDelayEvent | This event fires when stability levels change |
| CStabilityDelayListener | The interface that is required to implement StabilityDelayEvent |
| CTorchLuminanceEvent | This event fires when torch luminance level changes |
| CTorchLuminanceListener | The interface that is required to implement TorchLuminanceEvent |
| ▼Nkut | |
| ►Nutilities | |
| ►Nappstats | |
| ►CAppStatistics | Use the AppStatistics class for creating, saving, and exporting statistics related to SDK framework usage |
| CAppStatsExportFormat | Indicates the export format desired when calling the export method |
| CExportStatusEvent | |
| CThresholdType | |
| CAppStatsDaoField | Container for properties that define one field in a table in the datastore |
| CAppStatsDsExportHandler | |
| CAppStatsExportEvent | This event is fired when AppStats events are being exported |
| ►CAppStatsExportListener | |
| CExportStatus | |
| CAppStatsSessionEvent | This data-only class is used to set properties that define an AppStats Session Event |
| CAppStatsThresholdReachedEvent | |
| CAppstatsThresholdReachedListener | |
| ►CAppStatsWriteFileListener | |
| CWriteFileStatus | |
| CAppStatsWritetoFileEvent | |
| CAppStatsWriteToFileResults | |
| ►Nasync | |
| CListenerCallbackThreadType | An enum which identifies the thread type for asynchronous callbacks |
| ►Nerror | |
| CErrorInfo | The ErrorInfo enum can be used by application developers to lookup error information |
| CKmcException | An extended Exception class that specifies KMC errors as defined by the ErrorInfo enum |
| CKmcRuntimeException | An extended RuntimeException class that specifies KMC errors as defined by the ErrorInfo enum |
| ►Nversion | |
| CKutVersion | |
| CAppContextProvider | This class keeps a reference of the application context |
| CCertificateValidatorListener | |
| CKUTLogging | |
| ►CLicensing | This class comprises the licensing mechanism for Mobile SDK |
| CCustomAcquireVolumeLicenseEventListener | The listener interface for receiving custom acquire volume license events |
| CCustomAcquireVolumeLicenseRequestData | Data class for custom acquire volume license related operations |
| CLicenseServerType | An enum of license server types. Use with Licensing.setMobileSDKLicenseServer |
| CLicenseType | An enum of license types |
| CVolumeLicenseEventListener | The listener interface for receiving volume licensing events |
| CVolumeLicenseFailureData | Data class for volume licensing related failures |
| CVolumeLicenseResultData | Data class for volume licensing related successful operations |
| ►CMicrLine | This class represents the MICR line itself |
| CCheckType | An enum which identifies the type of check |
| CMicrParser | This class parses the MICR data line from different check detection algorithms |
| CSdkVersion | This class provides access to version information for the Kofax Mobile SDK |
| CSize | Universal class for image size describing |
| ▼Nmobile | |
| ▼Nsdk | |
| ►Ncapture | |
| ►Nbill | |
| CBillCaptureActivity | |
| CBillExtractActivity | |
| CBillExtractor | |
| CBillExtractorResponse | |
| CBillParameters | |
| CBillWorkflowActivity | |
| CIBillDeserializer | |
| CIBillExtractorListener | |
| CKtaBillExtractor | |
| CKtaJsonBill | |
| CRttiBillExtractor | |
| CRttiJsonBill | |
| ►Ncheck | |
| CCheckCaptureActivity | |
| CCheckExtractActivity | |
| CCheckExtractor | |
| CCheckExtractorResponse | |
| ►CCheckParameters | |
| CCheckCountry | |
| CCheckWorkflowActivity | |
| CICheckDeserializer | |
| CICheckExtractionServer | |
| CICheckExtractorListener | |
| CKtaCheckExtractor | |
| CKtaJsonCheck | |
| CRttiCheckExtractor | |
| CRttiJsonCheck | |
| ►Ncreditcard | |
| CCardIoWrapperActivity | |
| ►CCreditCardParameters | |
| CCardStyle | |
| CCreditCardWorkflowActivity | |
| ►Nextraction | |
| CExceptionResponse | |
| CExceptionResponseImpl | |
| CExtractor | |
| CExtractorResponse | |
| CIExtractorListener | |
| ►Nid | |
| CConventionBasedJsonIdDeserializer | |
| CIdCaptureActivity | |
| CIdCaptureBackActivity | |
| CIdExtractActivity | |
| CIdExtractor | |
| CIdExtractorResponse | |
| ►CIdParameters | |
| CIdSide | |
| CIdState | |
| CIdWorkflowActivity | |
| CIIdDeserializer | |
| CIIdExtractionServer | |
| CIIdExtractorListener | |
| CKtaIdExtractor | |
| CRttiIdExtractor | |
| ►Nmodel | |
| CBill | |
| CCaptureData | |
| CCheck | |
| CCheckIQAData | |
| CCheckUsabilityData | |
| CCreditCard | |
| CField | |
| CFieldLocation | |
| CId | |
| CPassport | |
| CPointDouble | |
| CSizeDouble | |
| ►Nparameter | |
| CExtractionCredentials | |
| ►CExtractionParameters | |
| CExtractionType | |
| CIParameters | |
| ►CLookAndFeelParameters | |
| CTorchMode | |
| ►CProcessingParameters | |
| CProcessingType | |
| ►Npassport | |
| CIPassportDeserializer | |
| CIPassportExtractorListener | |
| CKtaJsonPassport | |
| CKtaPassportExtractor | |
| CPassportCaptureActivity | |
| CPassportExtractActivity | |
| CPassportExtractor | |
| CPassportExtractorResponse | |
| CPassportParameters | |
| CPassportWorkflowActivity | |
| CRttiJsonPassport | |
| CRttiPassportExtractor | |
| ►Nprocessing | |
| CIImageProcessor | |
| CIImageProcessorListener | |
| CApplicationContextImageStore | |
| CCaptureActivity | |
| CContextImageStorage | |
| CExtractActivity | |
| CIImageStorage | |
| CImageReviewActivity | |
| CProcessActivity | |
| CWorkflowActivity | |
| ►Nextract | |
| ►Nid | |
| ►Nbundle | |
| CBundleCacheProvider | |
| CIBundle | |
| CIBundleCacheProvider | |
| CIBundleFile | |
| CZipFileBundle | |
| CZipInputStreamBundle | |
| CAggregateException | |
| CDataField | |
| CICompletionListener | |
| CIdExtractionParameters | |
| CIdRegion | |
| CIdType | |
| CIIdExtractionListener | |
| CIIdExtractionResult | |
| CIIdExtractor | |
| CIIdImageProcessingListener | |
| CImageField | |
| CIProjectProvider | |
| CListOfException | |
| ►CLocalProjectProvider | |
| ►CVersionTable | |
| CVersionList | |
| COnDeviceIdExtractor | |
| CProjectProviderException | |
| CQuickExtractor | |
| CQuickExtractorAgent | |
| CQuickExtractorAgentListener | |
| CQuickExtractorListener | |
| CQuickExtractorSettings | |
| ►CServerProjectProvider | |
| CError | |
| ►Nserver | |
| CExtractionServerException | |
| CIServerExtractor | |
| CLoginCredentials | |
| ►CServerBuilder | |
| CServerType | |
| CServerExtractionParameters | |
| CTimeOutParameters | |
| ►Nlogistics | |
| CCaptureServer | |
| CICaptureServer | |
| CIProgressListener | |
| CLogging |