kfxKUTAppStatistics.h

Go to the documentation of this file.

//  Kofax Mobile Capture API Reference File
//
//  kfxKUTAppStatistics.h
//
//  Copyright (c) 2012 - 2017 Kofax. Use of this code is with permission pursuant to Kofax license terms.
//
 
#import <Foundation/Foundation.h>
#import "kfxKUTAppStatisticsDelegate.h"
#import "kfxKUTAppStatsSessionEvent.h"
 
 
@interface kfxKUTAppStatistics : NSObject
 
 
+ (kfxKUTAppStatistics*)appStatisticsInstance;
 
@property int ramSizeThreshold;         // Memory usage size to trigger a warning event to the application.
 
@property int fileSizeThreshold;        // Flash usage size to trigger a warning event to the application.
 
@property (readonly) int ramSize;                  // Current memory usage
 
// ===================================================
 
@property (retain, readonly) NSString * filePath;
 
// ===================================================
 
@property (readonly) int fileSize;                 // Current flash storage usage
 
 
// ===================================================
 
@property (readonly) bool isRecording;             // Boolean indicating whether recording is active
 
 
 
// ===================================================
 
@property (nonatomic, copy) NSString* deviceID;
 
 
// ===================================================
 
@property (atomic, assign) id<kfxKUTAppStatisticsDelegate>      delegate;
 
 
// ===================================================
 
- (int) initAppStats:(NSString *) filePath;
 
 
// ===================================================
 
- (int) startRecord;
 
// ===================================================
 
- (int) stopRecord;
 
// ===================================================
 
- (int) writeToFile;
 
// ===================================================
 
- (int) export:(NSString *) exportFilePath withFormat:(KUTappStatsExportFormat) exportFormat;
 
 
// ===================================================
 
- (int) purge;
 
 
// ===================================================
//
-(int) beginSession:(NSString *) sessionKey withCategory:(NSString *) category;
 
// ===================================================
//
-(int) endSession:(Boolean) success withDescription:(NSString *) description;
 
// ===================================================
 
-(int) logSessionEvent:(kfxKUTAppStatsSessionEvent *) sessionEvent;
 
@end