kfxKUTAppStatisticsDelegate.h

Go to the documentation of this file.

//  Kofax Mobile Capture API Reference File
//
//  kfxKUTAppStatisticsDelegate.h
//
//  Copyright (c) 2012 - 2017 Kofax. Use of this code is with permission pursuant to Kofax license terms.
//

#import <Foundation/Foundation.h>

/* Enum identifying export status events */
typedef NS_ENUM(NSUInteger, KUTappStatsExport) {
    KUT_EXPORT_STATUS_EXPORTING = 1,
    KUT_EXPORT_STATUS_COMPLETE,
    KUT_EXPORT_STATUS_FAILED
};

/* Enum identifying export status events */
typedef NS_ENUM(NSUInteger, KUTappStatsWriteFile) {
    KUT_WRITEFILE_STATUS_EXPORTING = 1,
    KUT_WRITEFILE_STATUS_COMPLETE,
    KUT_WRITEFILE_STATUS_FAILED
};


/* Enum identifying either file or memory operations when report size events */
typedef NS_ENUM(NSUInteger, KUTappStatsThreshold) {
    KUT_THRESH_TYPE_RAM = 1,
    KUT_THRESH_TYPE_FILE
};

/* Enum identifying the AppStats export format */
typedef NS_ENUM(NSUInteger, KUTappStatsExportFormat) {
    KUT_EXPORT_TYPE_SQL = 0,
    KUT_EXPORT_TYPE_JSON
};

@protocol kfxKUTAppStatisticsDelegate<NSObject>

@required


/* Report the status of a writeToFile operation */
- (void) writeFileStatusEvent : (KUTappStatsWriteFile) type andProgress : (int) percentComplete withError: (int) errorCode withMsg: (NSString *) errorMsg;

/* Report the status of an export operation */
- (void) exportStatusEvent : (KUTappStatsExport) type andProgress : (int) percentComplete  withError: (int) errorCode withMsg: (NSString *) errorMsg;

@optional

- (NSString *) formatExportRow:(NSString *) tableName withFields:(NSMutableArray *) daoFields;

/* Report size threshold events to the application */
- (void) sizeThresholdReached : (KUTappStatsThreshold) type andSize : (int) size;


@end