com.mixer.interactive.event.control.input

Class ControlInputEvent

java.lang.Object

com.mixer.interactive.event.InteractiveEvent

com.mixer.interactive.event.control.input.ControlInputEvent

Direct Known Subclasses:

ControlKeyDownEvent, ControlKeyUpEvent, ControlMouseDownInputEvent, ControlMouseUpInputEvent, ControlMoveInputEvent

public class ControlInputEvent
extends InteractiveEvent

The class ParticipantEvent is the superclass of all classes relating to control input sent by the Interactive service to the GameClient.

Since:

1.0.0

Author:

Microsoft Corporation

Field Summary

Fields

Modifier and Type	Field and Description
protected InteractiveControlInput	input The InteractiveControlInput that was supplied by the InteractiveParticipant
protected String	participantID Identifier for the InteractiveParticipant that supplied the InteractiveControlInput
protected InteractiveTransaction	transaction The InteractiveTransaction associated with this input event, if one exists

Constructor Summary

Constructors

Constructor and Description
ControlInputEvent(String participantID, String transactionID, InteractiveControlInput input) Initializes a new ControlInputEvent.

Method Summary

Modifier and Type	Method and Description
InteractiveControlInput	getControlInput() Returns the InteractiveControlInput that was supplied by the InteractiveParticipant
String	getParticipantID() Returns the identifier for the InteractiveParticipant that supplied the InteractiveControlInput
InteractiveTransaction	getTransaction() Returns the InteractiveTransaction associated with this input event, if one exists.

Methods inherited from class com.mixer.interactive.event.InteractiveEvent

getRequestID, setRequestID

Methods inherited from class java.lang.Object

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

Field Detail

participantID

protected final String participantID

Identifier for the InteractiveParticipant that supplied the InteractiveControlInput

See Also:

InteractiveParticipant.sessionID

transaction

protected final InteractiveTransaction transaction

The InteractiveTransaction associated with this input event, if one exists

input

protected final InteractiveControlInput input

The InteractiveControlInput that was supplied by the InteractiveParticipant

Constructor Detail

ControlInputEvent

public ControlInputEvent(String participantID,
                         String transactionID,
                         InteractiveControlInput input)

Initializes a new ControlInputEvent.

Parameters:

participantID - Identifier for the InteractiveParticipant that supplied the InteractiveControlInput

transactionID - Identifier for an InteractiveTransaction associated with the input event

input - The InteractiveControlInput that was supplied by the InteractiveParticipant

Since:

1.0.0

Method Detail

getParticipantID

public String getParticipantID()

Returns the identifier for the InteractiveParticipant that supplied the InteractiveControlInput

Returns:

The identifier for the InteractiveParticipant that supplied the InteractiveControlInput

Since:

1.0.0

getTransaction

public InteractiveTransaction getTransaction()

Returns the InteractiveTransaction associated with this input event, if one exists.

Returns:

The InteractiveTransaction associated with this input event if one exists, null otherwise

Since:

1.0.0

getControlInput

public InteractiveControlInput getControlInput()

Returns the InteractiveControlInput that was supplied by the InteractiveParticipant

Returns:

The InteractiveControlInput that was supplied by the InteractiveParticipant

Since:

1.0.0