com.mixer.interactive.resources.scene

Class InteractiveScene

java.lang.Object

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

com.mixer.interactive.resources.scene.InteractiveScene

All Implemented Interfaces:

IInteractiveCreatable, IInteractiveDeletable, IInteractiveUpdatable, Comparable<InteractiveScene>

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

A InteractiveScene represents a scene resource 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
InteractiveScene(String sceneID) Initializes a new InteractiveScene.
InteractiveScene(String sceneID, Collection<InteractiveGroup> groups, Collection<InteractiveControl> controls) Initializes a new InteractiveScene.

Method Summary

Modifier and Type	Method and Description
int	compareTo(InteractiveScene o)
CompletableFuture<Boolean>	create(GameClient gameClient) Creates this on the Interactive service.
CompletableFuture<Boolean>	delete(GameClient gameClient) Deletes this from the Interactive service, reassigning groups on this scene to the default scene.
CompletableFuture<Boolean>	delete(GameClient gameClient, String reassignSceneID) Deletes this from the Interactive service, reassigning groups on this scene to the specified scene.
boolean	equals(Object o)
InteractiveControl	getControl(String controlID) Returns the InteractiveControl matching by controlID if this scene contains it, null otherwise.
Set<InteractiveControl>	getControls() Returns all InteractiveControls for this scene.
InteractiveGroup	getGroup(String groupID) Returns the InteractiveGroup matching by groupID if this scene contains it, null otherwise.
Set<InteractiveGroup>	getGroups() Returns all InteractiveGroups for this scene.
String	getSceneID() Returns the unique identifier for this scene.
protected InteractiveScene	getThis() Returns this as an instance of the specified generic.
int	hashCode()
boolean	isDefault() Returns true if this is the default scene, false otherwise.
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

InteractiveScene

public InteractiveScene(String sceneID)

Initializes a new InteractiveScene.

Parameters:

sceneID - Identifier for the InteractiveScene

Since:

1.0.0

InteractiveScene

public InteractiveScene(String sceneID,
                        Collection<InteractiveGroup> groups,
                        Collection<InteractiveControl> controls)

Initializes a new InteractiveScene.

Parameters:

sceneID - Identifier for the InteractiveScene

groups - A Collection of InteractiveGroups that are currently on this InteractiveScene

controls - A Collection of InteractiveControls that this InteractiveScene will contain

Since:

1.0.0

Method Detail

getSceneID

public String getSceneID()

Returns the unique identifier for this scene.

Returns:

Unique identifier for this scene

Since:

1.0.0

isDefault

public boolean isDefault()

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

Returns:

true if this is the default scene, false otherwise

Since:

1.0.0

getGroup

public InteractiveGroup getGroup(String groupID)

Returns the InteractiveGroup matching by groupID if this scene contains it, null otherwise.

Parameters:

groupID - Unique identifier for a InteractiveGroup

Returns:

The InteractiveGroup matching by groupID if this scene contains it, null otherwise

Since:

1.0.0

getGroups

public Set<InteractiveGroup> getGroups()

Returns all InteractiveGroups for this scene.

Returns:

Set of InteractiveGroups for this scene

Since:

1.0.0

getControl

public InteractiveControl getControl(String controlID)

Returns the InteractiveControl matching by controlID if this scene contains it, null otherwise.

Parameters:

controlID - Unique identifier for a InteractiveControl

Returns:

The InteractiveControl matching by controlID if this scene contains it, null otherwise

Since:

1.0.0

getControls

public Set<InteractiveControl> getControls()

Returns all InteractiveControls for this scene.

Returns:

Set of InteractiveControls for this scene

Since:

1.0.0

getThis

protected InteractiveScene getThis()

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

Specified by:

getThis in class InteractiveResource<InteractiveScene>

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

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 groups on this scene to the default scene.

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 deleteScene method call completes with no errors

Since:

1.0.0

See Also:

IInteractiveDeletable.delete(GameClient)

delete

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

Deletes this from the Interactive service, reassigning groups on this scene to the specified scene.

Parameters:

gameClient - The GameClient to use for the delete operation

reassignSceneID - Identifier for the InteractiveScene that InteractiveGroups will be reassigned to

Returns:

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

Since:

1.0.0

compareTo

public int compareTo(InteractiveScene o)

Specified by:

compareTo in interface Comparable<InteractiveScene>

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