Package wizardquest.telemetry

Class TelemetryEvent

java.lang.Object

wizardquest.telemetry.TelemetryEvent

Direct Known Subclasses:

SessionEvent, SettingsChangeEvent

public abstract class TelemetryEvent
extends Object

Constructor Summary

Constructors

Constructor	Description
TelemetryEvent(String userID, Instant timeStamp, String event)	Constructor for the base telemetry event.

Method Summary

Modifier and Type	Method	Description
String	getEvent()	Gets the name of the telemetry event according to the telemetry specification.
Instant	getTimestamp()	Gets the stored timestamp.
String	getUserID()	Gets the stored user ID.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TelemetryEvent

public TelemetryEvent(String userID,
 Instant timeStamp,
 String event)

Constructor for the base telemetry event. Produces a telemetry event storing common data.

Parameters:

userID - the ID of the user who is playing the game when the event is constructed.

timeStamp - the time the event was constructed in the format yyyy/mm/dd/hh/mm/ss

event - the name of the telemetry event according to the JSON telemetry specification.

source - the object that constructed the telemetry event.

sessionID - the ID of the session the user is currently playing. See TelemetryListenerInterface for information about sessions.

Method Details

getUserID

public String getUserID()

Gets the stored user ID.

Returns:

the user's ID.

getTimestamp

public Instant getTimestamp()

Gets the stored timestamp.

Returns:

the timestamp.

getEvent

public String getEvent()

Gets the name of the telemetry event according to the telemetry specification.

Returns:

the event's name.