Atalasoft MobileImage API Reference
kfxKUTAppStatistics.h
Go to the documentation of this file.
1 // Kofax Mobile Capture API Reference File
2 //
3 // kfxKUTAppStatistics.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>
11 
13 
18 @interface kfxKUTAppStatistics : NSObject
19 
21 
28 
30 @property int ramSizeThreshold; // Memory usage size to trigger a warning event to the application.
31 
33 @property int fileSizeThreshold; // Flash usage size to trigger a warning event to the application.
34 
36 @property (readonly) int ramSize; // Current memory usage
37 
38 // ===================================================
40 
43 @property (retain, readonly) NSString * filePath;
44 
45 // ===================================================
47 
50 @property (readonly) int fileSize; // Current flash storage usage
51 
52 
53 // ===================================================
55 
58 @property (readonly) bool isRecording; // Boolean indicating whether recording is active
59 
60 
61 
62 // ===================================================
64 
106 @property (nonatomic, copy) NSString* deviceID;
107 
108 
109 // ===================================================
111 
115 @property (atomic, assign) id<kfxKUTAppStatisticsDelegate> delegate;
116 
117 
118 // ===================================================
120 
124 - (int) initAppStats:(NSString *) filePath;
125 
126 
127 // ===================================================
129 
134 - (int) startRecord;
135 
136 // ===================================================
138 
144 - (int) stopRecord;
145 
146 // ===================================================
148 
157 - (int) writeToFile;
158 
159 // ===================================================
161 
169 - (int) export:(NSString *) exportFilePath withFormat:(KUTappStatsExportFormat) exportFormat;
170 
171 
172 // ===================================================
174 
176 - (int) purge;
177 
178 
179 // ===================================================
181 //
187 -(int) beginSession:(NSString *) sessionKey withCategory:(NSString *) category;
188 
189 // ===================================================
191 //
196 -(int) endSession:(Boolean) success withDescription:(NSString *) description;
197 
198 // ===================================================
200 
202 -(int) logSessionEvent:(kfxKUTAppStatsSessionEvent *) sessionEvent;
203 
204 
205 // ===================================================
207 
209 -(int) upgradeSchema:(NSString *) filePath;
210 
211 @end
212 
int fileSizeThreshold
fileSizeThreshold is the size in bytes at which a warning will be issued to the application. The warning indicates the file size has reached the limit established by the application.
Definition: kfxKUTAppStatistics.h:33
NSString * filePath
This property indicates the file path last set by the initAppStats method.
Definition: kfxKUTAppStatistics.h:43
int purge()
The purge method erases the AppStats memory buffer and the AppStats recording database file...
int stopRecord()
The stopRecord method deactivates statistics recording.
int writeToFile()
The writeToFile method writes the in-memory statistics buffer to the AppStats database.
int ramSize
The readonly ramSize variable keeps the current recording memory usage.
Definition: kfxKUTAppStatistics.h:36
bool isRecording
Determine if AppStats is currently recording.
Definition: kfxKUTAppStatistics.h:58
Use the singleton App Statistics object for creating, saving, and exporting statistics related to SDK...
Definition: kfxKUTAppStatistics.h:18
id< kfxKUTAppStatisticsDelegate > delegate
This delegate notifies you about progress and AppStats operations.
Definition: kfxKUTAppStatistics.h:115
kfxKUTAppStatistics * appStatisticsInstance()
Use this factory method to get a common app statistics object for use in your app.
int startRecord()
The startRecord method activates statistics recording.
NSString * deviceID
The deviceID.
Definition: kfxKUTAppStatistics.h:106
int ramSizeThreshold
ramSizeThreshold is the size in bytes at which a warning will be issued to the application. The warning indicates the memory used for status recording has reached the limit established by the application.
Definition: kfxKUTAppStatistics.h:30
App Statistics Session Events.
Definition: kfxKUTAppStatsSessionEvent.h:20
int fileSize
This property indicates the file size of the database.
Definition: kfxKUTAppStatistics.h:50
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.