com.mixer.interactive.resources.participant

Class InteractiveParticipant

java.lang.Object

com.mixer.interactive.resources.InteractiveResource<InteractiveParticipant>

com.mixer.interactive.resources.participant.InteractiveParticipant

All Implemented Interfaces:

IInteractiveUpdatable, Comparable<InteractiveParticipant>

public class InteractiveParticipant
extends InteractiveResource<InteractiveParticipant>
implements Comparable<InteractiveParticipant>

A InteractiveParticipant represents a participant using the Interactive service.

Since:

1.0.0

Author:

Microsoft Corporation

Field Summary

Fields inherited from class com.mixer.interactive.resources.InteractiveResource

meta

Constructor Summary

Constructors

Constructor and Description
InteractiveParticipant(String sessionID, Integer userID, String username, Integer level, Long lastInputAt, Long connectedAt, Boolean disabled, String groupID) Initializes a new InteractiveParticipant.

Method Summary

Modifier and Type	Method and Description
InteractiveParticipant	changeGroup(InteractiveGroup group) Changes the group that the participant is a member of.
InteractiveParticipant	changeGroup(String groupID) Changes the group that the participant is a member of.
int	compareTo(InteractiveParticipant participant)
boolean	equals(Object o)
Long	getConnectedAt() Returns the UTC unix timestamp (in milliseconds) when the participant connected.
String	getGroupID() Returns the identifier for the InteractiveGroup the participant is a member of.
Long	getLastInputAt() Returns the UTC unix timestamp (in milliseconds) since the participant last interacted with controls.
Integer	getLevel() Returns the participant's numeric (unsigned integer) Mixer level.
String	getSessionID() Returns the unique string identifier for the participant in this session.
protected InteractiveParticipant	getThis() Returns this as an instance of the specified generic.
Integer	getUserID() Returns the user id (as an unsigned integer) for the participant on Mixer.
String	getUsername() Returns the participant's username on Mixer.
int	hashCode()
Boolean	isDisabled() Returns whether or not a the participants’s input as been disabled
InteractiveParticipant	resetGroup() Moves the participant to the default InteractiveGroup.
InteractiveParticipant	setDisabled(Boolean disabled) Sets a participant's ability to provide input.
boolean	syncIfEqual(Collection<?> objects) Iterates through a Collection of Objects.
CompletableFuture<Boolean>	update(GameClient gameClient) Updates this on the Interactive service.

Methods inherited from class com.mixer.interactive.resources.InteractiveResource

addMetaProperty, getMeta, setMeta

Methods inherited from class java.lang.Object

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

Constructor Detail

InteractiveParticipant

public InteractiveParticipant(String sessionID,
                              Integer userID,
                              String username,
                              Integer level,
                              Long lastInputAt,
                              Long connectedAt,
                              Boolean disabled,
                              String groupID)

Initializes a new InteractiveParticipant.

Parameters:

sessionID - Unique string identifier for the participant in this session

userID - The user id (as an unsigned integer) for the participant on Mixer.

username - Participant's username on Mixer

level - Participant's numeric (unsigned integer) Mixer level

lastInputAt - UTC unix timestamp (in milliseconds) since the participant last interacted with controls

connectedAt - UTC unix timestamp (in milliseconds) when the participant connected

disabled - Whether or not a the participants’s input as been disabled

groupID - Identifier for the InteractiveGroup the participant is a member of

Since:

1.0.0

Method Detail

getSessionID

public String getSessionID()

Returns the unique string identifier for the participant in this session.

Returns:

Unique string identifier for the participant in this session

Since:

1.0.0

getUserID

public Integer getUserID()

Returns the user id (as an unsigned integer) for the participant on Mixer.

Returns:

The user id (as an unsigned integer) for the participant on Mixer

Since:

1.0.0

getUsername

public String getUsername()

Returns the participant's username on Mixer.

Returns:

The participant's username on Mixer

Since:

1.0.0

getLevel

public Integer getLevel()

Returns the participant's numeric (unsigned integer) Mixer level.

Returns:

The participant's numeric (unsigned integer) Mixer level

Since:

1.0.0

getLastInputAt

public Long getLastInputAt()

Returns the UTC unix timestamp (in milliseconds) since the participant last interacted with controls.

Returns:

UTC unix timestamp (in milliseconds) since the participant last interacted with controls

Since:

1.0.0

getConnectedAt

public Long getConnectedAt()

Returns the UTC unix timestamp (in milliseconds) when the participant connected.

Returns:

UTC unix timestamp (in milliseconds) when the participant connected

Since:

1.0.0

isDisabled

public Boolean isDisabled()

Returns whether or not a the participants’s input as been disabled

Returns:

true if the participant has had their input disabled, false otherwise

Since:

1.0.0

setDisabled

public InteractiveParticipant setDisabled(Boolean disabled)

Sets a participant's ability to provide input.

Parameters:

disabled - true if the participant should have their input disabled, false otherwise

Returns:

this for method chaining

Since:

1.0.0

getGroupID

public String getGroupID()

Returns the identifier for the InteractiveGroup the participant is a member of.

Returns:

Identifier for the InteractiveGroup the participant is a member of

Since:

1.0.0

changeGroup

public InteractiveParticipant changeGroup(String groupID)

Changes the group that the participant is a member of.

Parameters:

groupID - Identifier for the InteractiveGroup the participant will be moved to

Returns:

this for method chaining

Since:

1.0.0

changeGroup

public InteractiveParticipant changeGroup(InteractiveGroup group)

Changes the group that the participant is a member of.

Parameters:

group - InteractiveGroup the participant will be moved to

Returns:

this for method chaining

Since:

1.0.0

resetGroup

public InteractiveParticipant resetGroup()

Moves the participant to the default InteractiveGroup.

Returns:

this for method chaining

Since:

1.0.0

getThis

protected InteractiveParticipant getThis()

Returns this as an instance of the specified generic. Utilizes the getThis programming idiom.

Specified by:

getThis in class InteractiveResource<InteractiveParticipant>

Returns:

this as an object of type T

Since:

1.0.0

See Also:

InteractiveResource.getThis()

syncIfEqual

public boolean syncIfEqual(Collection<?> objects)

Iterates through a Collection of Objects. If this is found to be in the Collection then this has it's values updated.

Specified by:

syncIfEqual in class InteractiveResource<InteractiveParticipant>

Parameters:

objects - A Collection of Objects

Returns:

A CompletableFuture that when complete returns true if the provided Collection contains this

Since:

2.0.0

See Also:

InteractiveResource.syncIfEqual(Collection)

update

public CompletableFuture<Boolean> update(GameClient gameClient)

Updates this on the Interactive service.

Specified by:

update in interface IInteractiveUpdatable

Parameters:

gameClient - The GameClient to use for the update operation

Returns:

A CompletableFuture that when complete returns true if the update method call completes with no errors

Since:

1.0.0

See Also:

IInteractiveUpdatable.update(GameClient)

compareTo

public int compareTo(InteractiveParticipant participant)

Specified by:

compareTo in interface Comparable<InteractiveParticipant>

Since:

1.0.0

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Since:

1.0.0

equals

public boolean equals(Object o)

Overrides:

equals in class Object

Since:

1.0.0