Kofax Mobile SDK API Reference
Instance Methods | List of all members
<KFXServerExtractorDelegate> Protocol Reference

Server Extraction Protocol. More...

#import <kfxKLOServerExtractor.h>

Inheritance diagram for <KFXServerExtractorDelegate>:

Instance Methods

(void) - extractionSucceded:response:
 Extraction Results delegate method. More...
 
(void) - extractionFailed:response:errorData:
 Extraction Results delegate method. More...
 

Detailed Description

Server Extraction Protocol.

The KFXServerExtractorDelegate defines the protocol for the delegate Server Extractor calls during extraction.

Method Documentation

- (void) extractionFailed: (NSError *)  error
response: (NSURLResponse *)  response
errorData: (NSData *)  data 
required

Extraction Results delegate method.

This method is called when the extraction is failed and provides the error

The implementation of this method is required. General recommendation is to first look for the response code and if it is anything other than 200 (HTTP success), then look for errorData and the message in it and then look for error object to see any further errors.

Parameters
error: a NSError object which indicates the reason for the extraction failure. It can range from network errors to erros on the server due to quality of images and other internal server errors if any
data: Sometimes Server sends a JSON error response and not necessarily a error object. In such cases, the entire error message would be in the data object.
See also
kfxKLOServerExtractor
- (void) extractionSucceded: (NSData *)  extractionData
response: (NSURLResponse *)  response 
required

Extraction Results delegate method.

This method is called when the extraction is completed and provides the extraction results.

The implementation of this method is required.

Parameters
extractionData: a extractionData object with extraction results data. data can be either JSON data or XML data depending on the server that extracted the data. Generally all SMC projects BillPay, CheckDeposit and Mobile ID projects return JSON data
See also
kfxKLOServerExtractor

The documentation for this protocol was generated from the following file:
Untitled Document © 2018 Kofax, Inc. All rights reserved. Use is subject to license terms.