Atalasoft MobileImage API Reference
Public Member Functions | List of all members
com.kofax.kmc.kut.utilities.appstats.AppStatsSessionEvent Class Reference

This data-only class is used to set properties that define an AppStats Session Event. More...

Public Member Functions

 AppStatsSessionEvent ()
 Parameter-less default constructor. More...
 
 AppStatsSessionEvent (String type)
 Constructor which takes a Session Type as parameters. More...
 
 AppStatsSessionEvent (String type, String response)
 Constructor which takes a Session Type, and session event response as parameters. More...
 
String getType ()
 Return the application-defined Session Type. More...
 
void setType (String sessionType)
 Set the application-defined Session Type. More...
 
String getResponse ()
 Return the application-defined session event response (result). More...
 
void setResponse (String response)
 Set the application-defined session event response (result). More...
 

Detailed Description

This data-only class is used to set properties that define an AppStats Session Event.

The AppStatsSessionEvent data object includes all the properties necessary to define a specific AppStats Session event. It is passed as a parameter to the logSessionEvent method on the AppStatistics object.

Constructor & Destructor Documentation

com.kofax.kmc.kut.utilities.appstats.AppStatsSessionEvent.AppStatsSessionEvent ( )
inline

Parameter-less default constructor.

com.kofax.kmc.kut.utilities.appstats.AppStatsSessionEvent.AppStatsSessionEvent ( String  type)
inline

Constructor which takes a Session Type as parameters.

com.kofax.kmc.kut.utilities.appstats.AppStatsSessionEvent.AppStatsSessionEvent ( String  type,
String  response 
)
inline

Constructor which takes a Session Type, and session event response as parameters.

Member Function Documentation

String com.kofax.kmc.kut.utilities.appstats.AppStatsSessionEvent.getResponse ( )
inline

Return the application-defined session event response (result).

Returns the response (result) of a session event. This response is defined by the application. It typically would indicate whether the session event was successful, and if it failed, the reason for the failure.

Returns
response
String com.kofax.kmc.kut.utilities.appstats.AppStatsSessionEvent.getType ( )
inline

Return the application-defined Session Type.

Returns the specific type of Session event, or single step (a sort of sub-Session) in a sequence of steps which comprise a complete Session. Application-defined. Can be used to book-end a specific session event to calculate elapsed time, with a "session A start", and "session A end" type.

Returns
type
void com.kofax.kmc.kut.utilities.appstats.AppStatsSessionEvent.setResponse ( String  response)
inline

Set the application-defined session event response (result).

Sets the response (result) of a session event. This response is defined by the application and could indicate success, failure, or some type of error condition.

Parameters
response
void com.kofax.kmc.kut.utilities.appstats.AppStatsSessionEvent.setType ( String  sessionType)
inline

Set the application-defined Session Type.

Sets the specific type of Session event, or single step (a sort of sub-Session) in a sequence of steps which comprise a complete Session. Application-defined. Can be used to book-end a specific session event to calculate elapsed time, with a "session A start", and "session A end" type.

Parameters
sessionType

The documentation for this class was generated from the following file:
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.