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

#import <KFXServerConnectionProtocol.h>

Inheritance diagram for <KFXServerConnectionProtocol>:
KFXKTAServerConnection KFXRTTIServerConnection

Instance Methods

(void) - getRequest:images:completion:
 Get the necessary server request. More...
 
(void) - makeConnection::
 Connect to the server. More...
 
(void) - cancelConnection:
 Cancel connection to the server. More...
 

Properties

id< kfxKUTCertificateValidatorDelegatecertificateValidatorDelegate
 Certificate validator delegate. More...
 

Method Documentation

- (void) cancelConnection: (void(^)(NSError *error))  completionHandler

Cancel connection to the server.

cancels the extraction task.

Parameters
completionHandler- callback will be fired on completion.
  • error: contains an error if there is one.
- (void) getRequest: (NSDictionary *)  parameters
images: (NSArray *)  imageBytesArray
completion: (void(^)(NSURLRequest *request, NSError *error))  completionHandler 

Get the necessary server request.

Get the request in proper format necessary for the server to carry out extraction

Parameters
parameters- parameters needed for extraction like xregion, processimage etc (see server documentation)
imageBytesArray- image data objects in NSData format for each image
completionHandler- callback will be fired on completion. If nil no work will be done.
  • request: valid request to send to the server
  • error: contains an error if there is one.
- (void) makeConnection: (NSURLRequest *)  completion
: (void(^)(NSData *extractionData, NSURLResponse *response, NSError *error))  completionHandler 

Connect to the server.

make a connection to the sever using the request formed

Parameters
request- request formed earlier which has all the parameters and image data required on server
completionHandler- callback will be fired on completion.
  • extractionData: data received from the server It could be JSON or XML based on the server's response
  • error: contains an error if there is one.

Property Documentation

- (id<kfxKUTCertificateValidatorDelegate>) certificateValidatorDelegate
readwriterequirednonatomicstrong

Certificate validator delegate.

This property allows to set a custom handler for SSL certificate validation.

See also
kfxKUTCertificateValidatorDelegate

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.