|
Kofax Mobile SDK API Reference
|
| CkfxIDState(kfxIDStateCreation) | The ID state creation category |
| ►C<NSCoding> | |
| CKFXDocumentDimensions | The Dimensions of a Document |
| CKFXImageProcessorConfiguration | Image Processor Configuration Specifies Image Processing Options |
| CkfxKEDBarcodeResult | A single barcode found data item |
| CkfxKEDBoundingTetragon | Bounding Tetragon class holds four point data |
| CkfxKEDClassificationResult | A single classification result |
| CkfxKEDImage | An Image object contains an image and associated data |
| CkfxKEDQuickAnalysisFeedback | Quick Analysis Results Feedback Class |
| CkfxKEDQuickAnalysisSettings | |
| CkfxKLODocument | Document object is instantiated as a specific DocumentType |
| CkfxKLODocumentType | DocumentType object describes the attributes of a document |
| CkfxKLOField | Field object describes a Field object |
| CkfxKLOFieldType | FieldType object describes the attributes of a Field object |
| CkfxKLOPage | Page object contains an array of one or more Image Objects |
| ►C<NSCopying> | |
| CkfxBillCaptureParameters | The bill capture view controller parameters |
| CkfxCheckCaptureParameters | |
| CkfxCreditCardCaptureParameters | The credit card capture view controller parameters |
| CKFXDocumentDimensions | The Dimensions of a Document |
| CkfxExtractionCredentials | The extraction credentials class |
| CkfxExtractionParameters | The data extraction parameters class |
| CkfxIDCaptureParameters | The ID capture view controller parameters |
| CkfxIDState | The ID state class |
| CKFXImageProcessorConfiguration | Image Processor Configuration Specifies Image Processing Options |
| ►CkfxIParameters | The base class for capture view controller parameters |
| CkfxBillCaptureParameters | The bill capture view controller parameters |
| CkfxCheckCaptureParameters | |
| CkfxCreditCardCaptureParameters | The credit card capture view controller parameters |
| CkfxIDCaptureParameters | The ID capture view controller parameters |
| CkfxPassportCaptureParameters | The passport capture view controller parameters |
| CkfxLookAndFeelParameters | The look and feel parameters class |
| CkfxPassportCaptureParameters | The passport capture view controller parameters |
| CkfxProcessingParameters | The image processing parameters class |
| ►C<NSObject> | |
| C<kfxAcquireVolumeLicenseDelegate> | This protocol must be implemented by classes whose objects are used as kfxLicense delegates |
| ►CKFXBaseObjectCaptureExperience | Base class for rendering a visual experience on top of the capture control when it is facing front side and returning an image depending on the criteria set by the user |
| CKFXSelfieCaptureExperience | This class renders a visual experience on top of the capture control when it is facing front side and returns an image depending on the criteria set by the user |
| CKFXBundleCacheProvider | Bundle Cache Provider |
| ►C<KFXBundleCacheProviderProtocol> | Bundle Cache Provider protocol |
| CKFXBundleCacheProvider | Bundle Cache Provider |
| C<KFXBundleFileProtocol> | Bundle file protocol |
| ►C<KFXBundleProtocol> | Bundle protocol |
| CKFXZipBundle | Zip bundle |
| ►CkfxCaptureData | Base class for document data objects |
| CkfxBillData | This object represents bill data |
| CkfxCheckData | This object represents check data |
| CkfxCreditCardData | This object represents credit card data |
| CkfxIDData | This object represents id document data |
| CkfxPassportData | This object represents passport data |
| CKFXCaptureServer | The Capture server Class |
| ►C<KFXCaptureServerProtocol> | Capture Server protocol |
| CKFXCaptureServer | The Capture server Class |
| CkfxCheckIQAData | This object represents check IQA data |
| CkfxCheckUsabilityData | This object represents check usability data |
| CKFXCreditCard | |
| C<KFXCreditCardCapturedDelegate> | Defines the delegate methods for Credit Card capture |
| C<kfxCustomAcquireVolumeLicenseDelegate> | |
| CkfxDataField | Data field object |
| CKFXDocumentDimensions | The Dimensions of a Document |
| CkfxError | An error lookup reference class |
| CkfxExtractionCredentials | The extraction credentials class |
| CkfxExtractionParameters | The data extraction parameters class |
| CKFXIDExtractionParameters | ID exraction parameters object |
| CKFXIDExtractionResult | ID Extraction Result |
| CkfxIDState | The ID state class |
| CKFXImageProcessorConfiguration | Image Processor Configuration Specifies Image Processing Options |
| CkfxImageStorage | The image storage interface |
| CkfxIParameters | The base class for capture view controller parameters |
| CkfxKBRBarcodeReader | The barcode recognition engine |
| C<kfxKBRDelegate> | This protocol must be implemented by classes whose objects are used as kfxKBRBarcodeReader delegates |
| ►CkfxKCDDocumentBaseDetector | |
| CkfxKCDCheckDetector | Check Detector clss |
| CkfxKCDDocumentDetector | Document Detector class |
| CKFXPassportDetector | Passport Detector class |
| CkfxKEDBarcodeResult | A single barcode found data item |
| CkfxKEDBoundingRectangle | Bounding Rectangle of four coordinates |
| CkfxKEDBoundingTetragon | Bounding Tetragon class holds four point data |
| CkfxKEDClassificationResult | A single classification result |
| ►CkfxKEDDocumentBaseDetectionResult | A base class for detection results |
| CkfxKEDCheckDetectionResult | A result object returned by the Check Detector |
| CkfxKEDDocumentDetectionResult | A result object returned by the Document Detector |
| CKFXPassportDetectionResult | A result object returned by the Passport Detector |
| ►CkfxKEDDocumentBaseDetectionSettings | Base class for detector settings |
| CKFXFixedAspectRatioDetectionSettings | A configuration object for controlling the Fixed Aspect Ratio Detector |
| CkfxKEDCheckDetectionSettings | A configuration object for controlling the kfxKCDCheckDetector object |
| CkfxKEDDocumentDetectionSettings | A configuration object for controlling the kfxKCDDocumentDetector object |
| CKFXPassportDetectionSettings | A configuration object for controlling the KFXPassportDetector object |
| CkfxKEDGlareRemover | |
| CkfxKEDImage | An Image object contains an image and associated data |
| CkfxKEDQuickAnalysisFeedback | Quick Analysis Results Feedback Class |
| CkfxKEDQuickAnalysisSettings | |
| CkfxKENImageProcessor | The Image Processor Class |
| CkfxKENLogging | KfxLibEngines libarary logging features |
| CkfxKENVersion | This class includes a method which returns the SDK Engines package version |
| C<kfxKIPDelegate> | Image Processing Protocol |
| CkfxKLODocument | Document object is instantiated as a specific DocumentType |
| CkfxKLODocumentType | DocumentType object describes the attributes of a document |
| CkfxKLOField | Field object describes a Field object |
| CkfxKLOFieldType | FieldType object describes the attributes of a Field object |
| CkfxKLOLogging | KfxLibLogistics libarary logging features |
| CkfxKLOPage | Page object contains an array of one or more Image Objects |
| CkfxKLOServerExtractor | |
| CkfxKLOUserProfile | Server User Profile |
| CkfxKLOVersion | This class includes a method which returns the SDK Logistics Framework version |
| ►CkfxKOEField | Field object |
| CkfxKOEDataField | Data Field object |
| CkfxKOEImageField | Image Field object |
| CkfxKOEIDExtractor | The ID Extractor Class |
| C<kfxKOEIDImageProcessingDelegate> | ID Image Processing Protocol |
| CKFXKTAServerConnection | This class helps in making the connection to the KTA Server specified in the URL |
| C<kfxKUIBarCodeCaptureControlDelegate> | This protocol must be implemented by classes whose objects are used as kfxKUIBarCodeCaptureControl delegates |
| ►CkfxKUICaptureExperience | This class is a base class for the animation experience |
| ►CkfxKUIDocumentBaseCaptureExperience | This is the base class for check and document capture, that renders a visual experience on top of the capture control and returns an image, depending on the criteria set by the user |
| CKFXFixedAspectRatioCaptureExperience | This class renders a visual experience on top of the capture control and returns an image depending on the criteria set by the user |
| CkfxKUICheckCaptureExperience | This class renders a visual experience on top of the capture control and returns an image depending on the criteria set by the use |
| CkfxKUIDocumentCaptureExperience | This class renders a visual experience on top of the capture control and returns an image depending on the criteria set by the user |
| CKFXPassportCaptureExperience | This class renders a visual experience on top of the capture control and returns an image depending on the criteria set by the use |
| ►CkfxKUICaptureExperienceCriteriaHolder | This class allows the capture criteria to be configured |
| ►CkfxKUIDocumentBaseCaptureExperienceCriteriaHolder | |
| CKFXFixedAspectRatioCaptureExperienceCriteriaHolder | This class allows the Fixed Aspect Ratio detection related criteria to be configured |
| CkfxKUICheckCaptureExperienceCriteriaHolder | This class allows the check related criteria to be configured |
| CkfxKUIDocumentCaptureExperienceCriteriaHolder | This class allows the document related criteria to be configured |
| CKFXPassportCaptureExperienceCriteriaHolder | This class allows the passport related criteria to be configured |
| CkfxKUICaptureMessage | This class renders the messages on the Imagecapturecontrol |
| CkfxKUIFrame | This class defines a frame that can be applied to a capture control |
| ►C<kfxKUIImageCaptureControlDelegate> | This protocol must be implemented by classes whose objects are used as kfxKUIImageCaptureControl delegates |
| CkfxKUICaptureExperience | This class is a base class for the animation experience |
| CKFXQuickExtractorAgent | An extractor that extracts either a barcode or MRZ data and a face image during image capture |
| C<kfxKUILicenseCaptureControlDelegate> | This protocol must be implemented by classes whose objects are used as kfxKUILicenseCaptureControl delegates |
| CkfxKUILogging | KfxLibUIControls libarary logging features |
| CkfxKUIPageDetectionEvent | This class that indicates a page was detected in the camera preview |
| CkfxKUIVersion | This class includes a method which returns the SDK UIControls Framework version |
| C<kfxKUTAcquireVolumeLicenseDelegate> | This protocol must be implemented by classes whose objects are used as kfxKUTLicensing delegates |
| CkfxKUTAppStatistics | Use the singleton App Statistics object for creating, saving, and exporting statistics related to SDK framework usage |
| C<kfxKUTAppStatisticsDelegate> | |
| CkfxKUTAppStatsDaoField | Used as part of custom export process, for passing Application Statistics table entries to your export handler code in the formatExportRow delegate method |
| CkfxKUTAppStatsSessionEvent | App Statistics Session Events |
| C<kfxKUTCertificateValidatorDelegate> | This protocol defines methods that your delegate object may implement for custom certificate pinning logic |
| C<kfxKUTCustomAcquireVolumeLicenseDelegate> | |
| CkfxKUTCustomAcquireVolumeLicenseRequestData | |
| CkfxKUTCustomAcquireVolumeLicenseRequestData | |
| CkfxKUTLicensing | License for unlocking library features |
| CkfxKUTLogging | KfxLibUtilities libarary logging features |
| CkfxKUTMicrLine | |
| CkfxKUTMicrParser | |
| CkfxKUTSdkVersion | This class includes methods to determine the versions of several portions of the SDK, and the top level SDK Product version |
| CkfxKUTVoiceover | Accessibiity support |
| CkfxLicense | License for unlocking library features |
| CKFXLocalBundleProjectProvider | Local Bundle Project Provider |
| CkfxLogging | MobileSDK libarary logging features |
| CkfxLookAndFeelParameters | The look and feel parameters class |
| CkfxProcessingParameters | The image processing parameters class |
| ►C<KFXProjectProviderProtocol> | Project Provider protocol |
| CKFXLocalBundleProjectProvider | Local Bundle Project Provider |
| CKFXServerProjectProvider | Server Project Provider |
| CKFXQuickExtractionSettings | A configuration object for controlling the Quick Extractor behavior |
| CKFXQuickExtractor | An extractor that extracts either a barcode or MRZ data and a face image from a static source image |
| CKFXQuickExtractorAgent | An extractor that extracts either a barcode or MRZ data and a face image during image capture |
| C<KFXQuickExtractorAgentDelegate> | This protocol must be implemented by classes whose objects are used as KFXQuickExtractorAgent delegates |
| CKFXRTTIServerConnection | This class helps in making the connection to the RTTI Server specified in the URL |
| CKFXSelfieCaptureExperienceCriteriaHolder | |
| CKFXSelfieDetectionSettings | |
| ►C<KFXServerConnectionProtocol> | |
| CKFXKTAServerConnection | This class helps in making the connection to the KTA Server specified in the URL |
| CKFXRTTIServerConnection | This class helps in making the connection to the RTTI Server specified in the URL |
| CKFXServerExtractionParameters | |
| C<KFXServerExtractorDelegate> | Server Extraction Protocol |
| CKFXServerProjectProvider | Server Project Provider |
| CKFXTesseractOCR | Tesseract OCR initializer |
| CKFXZipBundle | Zip bundle |
| ►C<NSObjectNSObject> | |
| C<kfxKOEIDExtractorDelegate> | ID Extraction Protocol |
| ►CUIControl | |
| CkfxKUIImageReviewAndEdit | Displays an image for review, and an optional crop rectangle/tetragon for a user to manually adjust the page boundaries |
| ►CUIView | |
| CKFXCreditCardCaptureView | |
| CkfxKUIBarCodeCaptureControl | This class renders the camera preview to the screen and searches for barcodes |
| CkfxKUIImageCaptureControl | This class renders the camera preview to the screen and returns an image |
| CkfxKUILicenseCaptureControl | This class renders the camera preview to the screen and searches for an SDK license key in a QR code |
| ►CUIViewController | |
| ►CkfxCaptureViewController | This is an abstract base class for capture view controller. kfxCaptureViewController provides entire capture control along with capture guidance experience, image processing and data extraction functionality. It has a single entry and exit point. The capture view controller behavior and visual look and feel are customized thru a set of parameters. Capture view controller supports the delegate protocol to provide feedback to a client, with result data and error object if applicable |
| CkfxBillCaptureViewController | Bill capture view controller |
| CkfxCheckCaptureViewController | Check capture view controller |
| CkfxCreditCardCaptureViewController | Credit card capture view controller |
| CkfxIDCaptureViewController | ID capture view controller |
| CkfxPassportCaptureViewController | Passport capture view controller |
| ►C<UIViewControllerNSObject> | |
| ►C<kfxCaptureViewControllerDelegate> | This protocol defines methods that your delegate object should implement to interact with inherited classes from kfxCaptureViewController |
| C<kfxBillCaptureViewControllerDelegate> | This protocol defines methods that your delegate object should implement to interact with kfxBillCaptureViewController |
| C<kfxCheckCaptureViewControllerDelegate> | This protocol defines methods that your delegate object should implement to interact with kfxCheckCaptureViewController |
| C<kfxCreditCardCaptureViewControllerDelegate> | This protocol defines methods that your delegate object should implement to interact with kfxCreditCardCaptureViewController |
| C<kfxIDCaptureViewControllerDelegate> | This protocol defines methods that your delegate object should implement to interact with kfxIDCaptureViewController |
| C<kfxPassportCaptureViewControllerDelegate> | This protocol defines methods that your delegate object should implement to interact with kfxPassportCaptureViewController |