com.mixer.interactive.resources.group

Class InteractiveGroup

java.lang.Object

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

com.mixer.interactive.resources.group.InteractiveGroup

All Implemented Interfaces:

IInteractiveCreatable, IInteractiveDeletable, IInteractiveUpdatable, Comparable<InteractiveGroup>

public class InteractiveGroup
extends InteractiveResource<InteractiveGroup>
implements IInteractiveCreatable, IInteractiveDeletable, Comparable<InteractiveGroup>

A InteractiveGroup represents a group on 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
InteractiveGroup(String groupID) Initializes a new InteractiveGroup.
InteractiveGroup(String groupID, String sceneID) Initializes a new InteractiveGroup.

Method Summary

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.

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

InteractiveGroup

public InteractiveGroup(String groupID)

Initializes a new InteractiveGroup.

Parameters:

groupID - Identifier for the InteractiveGroup

Since:

1.0.0

InteractiveGroup

public InteractiveGroup(String groupID,
                        String sceneID)

Initializes a new InteractiveGroup.

Parameters:

groupID - Identifier for the InteractiveGroup

sceneID - Identifier for the InteractiveScene for the InteractiveGroup

Since:

1.0.0

Method Detail

getGroupID

public String getGroupID()

Returns the identifier for the InteractiveGroup.

Returns:

Identifier for the InteractiveGroup

Since:

1.0.0

isDefault

public boolean isDefault()

Returns true if this is the default group, false otherwise.

Returns:

true if this is the default group, false otherwise

Since:

1.0.0

getSceneID

public String getSceneID()

Returns the identifier for the InteractiveScene for the InteractiveGroup.

Returns:

Identifier for the InteractiveScene for the InteractiveGroup

Since:

1.0.0

setScene

public InteractiveGroup setScene(String sceneID)

Sets the InteractiveScene for the InteractiveGroup.

Parameters:

sceneID - Identifier for the InteractiveScene for the InteractiveGroup

Returns:

this for method chaining

Since:

1.0.0

setScene

public InteractiveGroup setScene(InteractiveScene scene)

Sets the InteractiveScene for the InteractiveGroup.

Parameters:

scene - InteractiveScene for the InteractiveGroup

Returns:

this for method chaining

Since:

1.0.0

getThis

protected InteractiveGroup getThis()

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

Specified by:

getThis in class InteractiveResource<InteractiveGroup>

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<InteractiveGroup>

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)

create

public CompletableFuture<Boolean> create(GameClient gameClient)

Creates this on the Interactive service.

Specified by:

create in interface IInteractiveCreatable

Parameters:

gameClient - The GameClient to use for the create operation

Returns:

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

Since:

2.0.0

See Also:

IInteractiveCreatable.create(GameClient)

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:

2.0.0

See Also:

IInteractiveUpdatable.update(GameClient)

delete

public CompletableFuture<Boolean> delete(GameClient gameClient)

Deletes this from the Interactive service, reassigning participants of this group to the default group.

Specified by:

delete in interface IInteractiveDeletable

Parameters:

gameClient - The GameClient to use for the delete operation

Returns:

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

Since:

1.0.0

See Also:

IInteractiveDeletable.delete(GameClient)

delete

public CompletableFuture<Boolean> delete(GameClient gameClient,
                                         String reassignGroupID)

Deletes this from the Interactive service, reassigning participants of this group to the specified group.

Parameters:

gameClient - The GameClient to use for the delete operation

reassignGroupID - The identifier for the InteractiveGroup that InteractiveParticipants will be reassigned to

Returns:

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

Since:

1.0.0

compareTo

public int compareTo(InteractiveGroup o)

Specified by:

compareTo in interface Comparable<InteractiveGroup>

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