This class helps in making the connection to the KTA Server specified in the URL. More...
#import <KFXKTAServerConnection.h>
Instance Methods | |
| (instancetype) | - initWithURL: |
| Constructor for the connection. More... | |
| (void) | - login:: |
| Method to login to KTA Server. More... | |
 Instance Methods inherited from <KFXServerConnectionProtocol> | |
| (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 | |
| NSTimeInterval | requestTimeout |
| Set request timeout. More... | |
| Properties inherited from <KFXServerConnectionProtocol> | |
| id< kfxKUTCertificateValidatorDelegate > | certificateValidatorDelegate |
| Certificate validator delegate. More... | |
Detailed Description
This class helps in making the connection to the KTA Server specified in the URL.
This class is responsible for constructing a request necessary to perform extraction.It can perform the login to KTA Server.It then makes a connection to the Server using the request formed earlier and returns the results.
Method Documentation
| - (instancetype) initWithURL: | (NSURL *) | serverURL |
Constructor for the connection.
The constructor allows to specify the required URL on which the extraction can be performed.
- Parameters
-
serverURL a valid KTA server url
| - (void) login: | (NSDictionary *) | parameters | |
| : | (void(^)(NSString *sessionId, NSURLResponse *response, NSError *error)) | completionHandler | |
Method to login to KTA Server.
This method allows user to login to KTA server and retrieve the necessary parameters like jobID, sessionID so that they can be subsequently passed as parameters for extraction.
- Parameters
-
parameters - the parameters needed to login. e.g. user credentials
- Return values
-
returns the sessionId and the response received from the server during the login request
Property Documentation
|
readwritenonatomicassign |
Set request timeout.
This method allows to customize request timeout for HTTP requests.
Changing the timeout value will not affect the current session, it will take effect during the next session.
Default value is 20 seconds.
The documentation for this class was generated from the following file: