Kofax Mobile SDK API Reference
Properties | List of all members
kfxKUTAppStatsSessionEvent Class Reference

App Statistics Session Events. More...

#import <kfxKUTAppStatsSessionEvent.h>

Inheritance diagram for kfxKUTAppStatsSessionEvent:

Properties

NSString * type
 Type of event. More...
 
NSString * response
 Used to indicate response to an operation. More...
 
NSString * documentID
 documentID of affected document if event pertains to an operation on a document More...
 

Detailed Description

App Statistics Session Events.

Session Events are used by the application to record events of interest with timestamps. An instance of this class contains the properties you use to set a session event. Session events are completely application defined, so type can be any meaningful string that the application uses to describe the session event being logged. This will show up in the exported data and can be reported on. documentID is optional, as not all session events relate to a particular document.

Property Documentation

- (NSString*) documentID
readwritenonatomicstrong

documentID of affected document if event pertains to an operation on a document

documentID is optional, as not all session events relate to a particular document.

- (NSString*) response
readwritenonatomicstrong

Used to indicate response to an operation.

Here you can record the result of an operation, such as response returned back from a server, or whether a processing operation succeeded or failed, etc.

- (NSString*) type
readwritenonatomicstrong

Type of event.

Any meaningful string that would indicate what type of event is being logged. For example, when you begin a session, you pass in a sessionKey and an application defined Category name (such as "CheckDeposit"). So type here would be a type of event within that category.. such as "CheckExtractionReceived"


The documentation for this class was generated from the following file:
Untitled Document © 2018 Kofax, Inc. All rights reserved. Use is subject to license terms.