Atalasoft MobileImage API Reference
kfxKUTAppStatisticsDelegate.h
Go to the documentation of this file.
1 // Kofax Mobile Capture API Reference File
2 //
3 // kfxKUTAppStatisticsDelegate.h
4 //
5 // Copyright (c) 2012 - 2016 Kofax. Use of this code is with permission pursuant to Kofax license terms.
6 //
7 
8 #import <Foundation/Foundation.h>
9 
11 /* Enum identifying export status events */
12 typedef NS_ENUM(NSUInteger, KUTappStatsExport) {
13  KUT_EXPORT_STATUS_EXPORTING = 1,
14  KUT_EXPORT_STATUS_COMPLETE,
15  KUT_EXPORT_STATUS_FAILED
16 };
17 
19 /* Enum identifying export status events */
20 typedef NS_ENUM(NSUInteger, KUTappStatsWriteFile) {
21  KUT_WRITEFILE_STATUS_EXPORTING = 1,
22  KUT_WRITEFILE_STATUS_COMPLETE,
23  KUT_WRITEFILE_STATUS_FAILED
24 };
25 
26 
28 /* Enum identifying either file or memory operations when report size events */
29 typedef NS_ENUM(NSUInteger, KUTappStatsThreshold) {
30  KUT_THRESH_TYPE_RAM = 1,
31  KUT_THRESH_TYPE_FILE
32 };
33 
35 /* Enum identifying the AppStats export format */
36 typedef NS_ENUM(NSUInteger, KUTappStatsExportFormat) {
37  KUT_EXPORT_TYPE_SQL = 0,
38  KUT_EXPORT_TYPE_JSON
39 };
40 
41 @protocol kfxKUTAppStatisticsDelegate <NSObject>
42 
43 @required
44 
45 
47 /* Report the status of a writeToFile operation */
48 - (void) writeFileStatusEvent : (KUTappStatsWriteFile) type andProgress : (int) percentComplete withError: (int) errorCode withMsg: (NSString *) errorMsg;
49 
51 /* Report the status of an export operation */
52 - (void) exportStatusEvent : (KUTappStatsExport) type andProgress : (int) percentComplete withError: (int) errorCode withMsg: (NSString *) errorMsg;
53 
54 @optional
55 
57 - (NSString *) formatExportRow:(NSString *) tableName withFields:(NSMutableArray *) daoFields;
58 
60 /* Report size threshold events to the application */
61 - (void) sizeThresholdReached : (KUTappStatsThreshold) type andSize : (int) size;
62 
63 
64 @end
typedef NS_ENUM(NSUInteger, KUTappStatsExport)
The KUTappStatsExport enum is used to identify status values for the exportStatusEvent delegate (indi...
Definition: kfxKUTAppStatisticsDelegate.h:12
Definition: kfxKUTAppStatisticsDelegate.h:41
Untitled Document © 2016 Atalasoft, Inc., 116 Pleasant St, Suite 321, Easthampton, MA 01027, U.S.A. All rights reserved. Use is subject to license terms.