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

◆ AppStatsSessionEvent() [1/3]

AppStatsSessionEvent ( )

Parameter-less default constructor.

◆ AppStatsSessionEvent() [2/3]

AppStatsSessionEvent ( String type )

Constructor which takes a Session Type as parameters.

◆ AppStatsSessionEvent() [3/3]

AppStatsSessionEvent	(	String	type,
		String	response
	)

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

Member Function Documentation

◆ getResponse()

String getResponse ( )

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

◆ getType()

String getType ( )

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

◆ setResponse()

void setResponse ( String response )

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

◆ setType()

void setType ( String sessionType )

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.