KFXCaptureServerProtocol.h

Go to the documentation of this file.

//
//  KFXCaptureServerProtocol.h
//  kfxLibLogistics
//
//  Copyright (c) 2017 Kofax. Use of this code is with permission pursuant to Kofax license terms.
//
//

#import "kfxKLOUserProfile.h"
#import "kfxKLODocument.h"
#import "kfxKLODocumentType.h"
#import <Foundation/Foundation.h>


@protocol KFXCaptureServerProtocol<NSObject>

// ========================================================================================================

-(void)registerDevice:(void(^)(int responseCode,NSError* error))completionHandler;


// ========================================================================================================

-(void)login:(kfxKLOUserProfile*)userProfile completionHandler:(void(^)(int responseCode,NSArray* documentTypeNames,NSError* error))completionHandler;


// ========================================================================================================

-(void)loginAnonymously:(void(^)(int responseCode,NSArray* documentTypeNames,NSError* error))completionHandler;


// ========================================================================================================

-(void)getDocumentType:(NSString*) documentTypeName completionHandler:(void(^)(int responseCode,kfxKLODocumentType* documentTypeObject,NSError* error))completionHandler;


// ========================================================================================================

-(void)submitDocument:(kfxKLODocument*)document completionHandler:(void(^)(int responseCode,NSError* error))completionHandler progressHandler:(void(^)(int progress,NSString* submissionJobId,NSError* error))progressHandler;


// ========================================================================================================

-(int)cancelSubmission:(NSString*)submissionJobId;


// ========================================================================================================

-(void)logout:(void(^)(int responseCode,NSError* error))completionHandler;

// ========================================================================================================

-(void)startJobService:(void(^)(NSString* jobID, int responseCode,NSError* error))completionHandler;

// ========================================================================================================

-(void)sendImageService:(kfxKLODocument*)document image:(kfxKEDImage*)image jobID:(NSString*) jobID imageIndex:(int) index lastImage: (BOOL) isLastImage completionHandler:(void(^)(int responseCode,NSError* error))completionHandler;

@end