public class InteractiveParticipant extends InteractiveResource<InteractiveParticipant> implements Comparable<InteractiveParticipant>
InteractiveParticipant
represents a participant using the Interactive service.meta
Constructor and Description |
---|
InteractiveParticipant(String sessionID,
Integer userID,
String username,
Integer level,
Long lastInputAt,
Long connectedAt,
Boolean disabled,
String groupID)
Initializes a new
InteractiveParticipant . |
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. |
addMetaProperty, getMeta, setMeta
public InteractiveParticipant(String sessionID, Integer userID, String username, Integer level, Long lastInputAt, Long connectedAt, Boolean disabled, String groupID)
InteractiveParticipant
.sessionID
- Unique string identifier for the participant in this sessionuserID
- The user id (as an unsigned integer) for the participant on Mixer.username
- Participant's username on Mixerlevel
- Participant's numeric (unsigned integer) Mixer levellastInputAt
- UTC unix timestamp (in milliseconds) since the participant last interacted with controlsconnectedAt
- UTC unix timestamp (in milliseconds) when the participant connecteddisabled
- Whether or not a the participants’s input as been disabledgroupID
- Identifier for the InteractiveGroup
the participant is a member ofpublic String getSessionID()
public Integer getUserID()
public String getUsername()
public Integer getLevel()
public Long getLastInputAt()
public Long getConnectedAt()
public Boolean isDisabled()
true
if the participant has had their input disabled, false
otherwisepublic InteractiveParticipant setDisabled(Boolean disabled)
disabled
- true
if the participant should have their input disabled, false
otherwisethis
for method chainingpublic String getGroupID()
InteractiveGroup
the participant is a member of.InteractiveGroup
the participant is a member ofpublic InteractiveParticipant changeGroup(String groupID)
groupID
- Identifier for the InteractiveGroup
the participant will be moved tothis
for method chainingpublic InteractiveParticipant changeGroup(InteractiveGroup group)
group
- InteractiveGroup
the participant will be moved tothis
for method chainingpublic InteractiveParticipant resetGroup()
InteractiveGroup
.this
for method chainingprotected InteractiveParticipant getThis()
this
as an instance of the specified generic. Utilizes the
getThis
programming idiom.getThis
in class InteractiveResource<InteractiveParticipant>
this
as an object of type TInteractiveResource.getThis()
public boolean syncIfEqual(Collection<?> objects)
Collection
of Objects. If this
is found to be in the
Collection
then this
has it's values updated.syncIfEqual
in class InteractiveResource<InteractiveParticipant>
objects
- A Collection
of ObjectsCompletableFuture
that when complete returns true
if the
provided Collection
contains this
InteractiveResource.syncIfEqual(Collection)
public CompletableFuture<Boolean> update(GameClient gameClient)
this
on the Interactive service.update
in interface IInteractiveUpdatable
gameClient
- The GameClient
to use for the update operationCompletableFuture
that when complete returns true
if the
update
method call completes with no errorsIInteractiveUpdatable.update(GameClient)
public int compareTo(InteractiveParticipant participant)
compareTo
in interface Comparable<InteractiveParticipant>
Copyright © 2018. All rights reserved.