public class InteractiveGroup extends InteractiveResource<InteractiveGroup> implements IInteractiveCreatable, IInteractiveDeletable, Comparable<InteractiveGroup>
InteractiveGroup
represents a group on the Interactive service.meta
Constructor and Description |
---|
InteractiveGroup(String groupID)
Initializes a new
InteractiveGroup . |
InteractiveGroup(String groupID,
String sceneID)
Initializes a new
InteractiveGroup . |
Modifier and Type | Method and Description |
---|---|
int |
compareTo(InteractiveGroup o) |
CompletableFuture<Boolean> |
create(GameClient gameClient)
Creates
this on the Interactive service. |
CompletableFuture<Boolean> |
delete(GameClient gameClient)
Deletes
this from the Interactive service, reassigning participants of this group to the default group. |
CompletableFuture<Boolean> |
delete(GameClient gameClient,
String reassignGroupID)
Deletes
this from the Interactive service, reassigning participants of this group to the specified group. |
boolean |
equals(Object o) |
String |
getGroupID()
Returns the identifier for the
InteractiveGroup . |
String |
getSceneID()
Returns the identifier for the
InteractiveScene for the InteractiveGroup . |
protected InteractiveGroup |
getThis()
Returns
this as an instance of the specified generic. |
int |
hashCode() |
boolean |
isDefault()
Returns
true if this is the default group, false otherwise. |
InteractiveGroup |
setScene(InteractiveScene scene)
Sets the
InteractiveScene for the InteractiveGroup . |
InteractiveGroup |
setScene(String sceneID)
Sets the
InteractiveScene for the InteractiveGroup . |
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 InteractiveGroup(String groupID)
InteractiveGroup
.groupID
- Identifier for the InteractiveGroup
public String getGroupID()
InteractiveGroup
.InteractiveGroup
public boolean isDefault()
true
if this is the default group, false
otherwise.true
if this is the default group, false
otherwisepublic String getSceneID()
InteractiveScene
for the InteractiveGroup
.InteractiveScene
for the InteractiveGroup
public InteractiveGroup setScene(String sceneID)
InteractiveScene
for the InteractiveGroup
.sceneID
- Identifier for the InteractiveScene
for the InteractiveGroup
this
for method chainingpublic InteractiveGroup setScene(InteractiveScene scene)
InteractiveScene
for the InteractiveGroup
.scene
- InteractiveScene
for the InteractiveGroup
this
for method chainingprotected InteractiveGroup getThis()
this
as an instance of the specified generic. Utilizes the
getThis
programming idiom.getThis
in class InteractiveResource<InteractiveGroup>
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<InteractiveGroup>
objects
- A Collection
of ObjectsCompletableFuture
that when complete returns true
if the
provided Collection
contains this
InteractiveResource.syncIfEqual(Collection)
public CompletableFuture<Boolean> create(GameClient gameClient)
this
on the Interactive service.create
in interface IInteractiveCreatable
gameClient
- The GameClient
to use for the create operationCompletableFuture
that when complete returns true
if the
create
method call completes with no errorsIInteractiveCreatable.create(GameClient)
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 CompletableFuture<Boolean> delete(GameClient gameClient)
this
from the Interactive service, reassigning participants of this group to the default group.delete
in interface IInteractiveDeletable
gameClient
- The GameClient
to use for the delete operationCompletableFuture
that when complete returns true
if the
delete
method call completes with no errorsIInteractiveDeletable.delete(GameClient)
public CompletableFuture<Boolean> delete(GameClient gameClient, String reassignGroupID)
this
from the Interactive service, reassigning participants of this group to the specified group.gameClient
- The GameClient
to use for the delete operationreassignGroupID
- The identifier for the InteractiveGroup
that InteractiveParticipants
will be
reassigned toCompletableFuture
that when complete returns true
if the
delete
method call completes with no errorspublic int compareTo(InteractiveGroup o)
compareTo
in interface Comparable<InteractiveGroup>
Copyright © 2018. All rights reserved.