KFXCaptureServer Class Reference

The Capture server Class. More...

#import <KFXCaptureServer.h>

Inheritance diagram for KFXCaptureServer:

Instance Methods
(id)	- initWithType:URL:
	Constructor for KTA or KFS. More...
Instance Methods inherited from <KFXCaptureServerProtocol>
(void)	- registerDevice:
	Register your mobile device with the server. More...
(void)	- login:completionHandler:
	Log into the server. More...
(void)	- loginAnonymously:
	Fetches the device profile shortcuts from the server. More...
(void)	- getDocumentType:completionHandler:
	Get a DocumentType Object. More...
(void)	- submitDocument:completionHandler:progressHandler:
	Submit a Document to the server. More...
(int)	- cancelSubmission:
	Cancel current operation. More...
(void)	- logout:
	Logout from the server. More...
(void)	- startJobService:
	Initiate the submission process of a document to the server. More...
(void)	- sendImageService:image:jobID:imageIndex:lastImage:completionHandler:
	Send an image to the server. More...

Properties
int	serverTimeout
	Use this property to specify the timeout of server SOAP requests. More...
id< kfxKUTCertificateValidatorDelegate >	certificateValidatorDelegate
	The certificate validator delegate. More...

Detailed Description

The Capture server Class.

Framework: libLogistics Import suggestion: #import <kfxLibLogistics/kfxLogistics.h> Relevant Header File: KFXCaptureServer.h An instance of this class contains methods to interact with the server.

Initialization** Default constructor ([KFXCaptureServer new] or [[KFXCaptureServer alloc] init]) returns nil.

[[KFXCaptureServer alloc] initWithType:KLO_SERVER_KFS URL:"http://ip/KFS/axis2/services/"] - capture server will be initialized with provided url and type.

Licensing**

Server communication requires a valid license to be set.

See also

kfxKUTLicensing

KFXCaptureServerProtocol

Method Documentation

- (id) initWithType:		(KLOsourceServer)	serverType
URL:		(NSString *)	serverURL

Constructor for KTA or KFS.

This constructor allows to specify KFS or KTA.

Parameters

serverType	- type of the server.
serverURL	- url of the server that you want to do operations on

Property Documentation

- (id<kfxKUTCertificateValidatorDelegate>) certificateValidatorDelegate

readwritenonatomicweak

The certificate validator delegate.

The delegate receives certificate validation challenge in response to an authentication request from the remote server.

See also

kfxKUTCertificateValidatorDelegate

- (int) serverTimeout

readwriteatomic

Use this property to specify the timeout of server SOAP requests.

Timeout defaults to 20 seconds. Can be overridden to any number of seconds to specify how long SOAP calls should be allowed to take before returning a timeout error.
Note that providing an invalid value (such as 0 or any negative number) will reset the timeout to the default value.

KFXCaptureServer *serverObject = [[KFXCaptureServer alloc]initWithType:KLO_SERVER_KFS URL:@"http://ip/KFS/axis2/services/"];
serverObject.serverTimeout = 120;

---

The documentation for this class was generated from the following file:

• KFXCaptureServer.h