com.mixer.interactive.services

Class SceneServiceProvider

java.lang.Object

com.mixer.interactive.services.AbstractServiceProvider

com.mixer.interactive.services.SceneServiceProvider

public class SceneServiceProvider
extends AbstractServiceProvider

Provides all functionality relating to making requests and interpreting replies from the Interactive service regarding scenes.

Since:

1.0.0

Author:

Microsoft Corporation

See Also:

InteractiveScene

Field Summary

Fields inherited from class com.mixer.interactive.services.AbstractServiceProvider

gameClient

Constructor Summary

Constructors

Constructor and Description
SceneServiceProvider(GameClient gameClient) Initializes a new SceneServiceProvider.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Set<InteractiveScene>>	create(Collection<InteractiveScene> scenes) Creates one or more new scenes.
CompletableFuture<Set<InteractiveScene>>	create(InteractiveScene... scenes) Creates one or more new scenes.
CompletableFuture<Boolean>	delete(String sceneID) Removes a scene from the Interactive integration, reassigning any groups who were on that scene to the default one.
CompletableFuture<Boolean>	delete(String sceneID, String reassignSceneID) Removes a scene from the Interactive integration, reassigning any groups who were on that scene to a different one.
CompletableFuture<Set<InteractiveScene>>	getScenes() Retrieves all the scenes for the Interactive integration.
CompletableFuture<Set<InteractiveScene>>	update(Collection<InteractiveScene> scenes) Updates scenes that already exist.
CompletableFuture<Set<InteractiveScene>>	update(int priority, Collection<InteractiveScene> scenes) Updates scenes that already exist.
CompletableFuture<Set<InteractiveScene>>	update(InteractiveScene... scenes) Updates scenes that already exist.
CompletableFuture<Set<InteractiveScene>>	update(int priority, InteractiveScene... scenes) Updates scenes that already exist.

Methods inherited from class com.mixer.interactive.services.AbstractServiceProvider

equals, hashCode

Methods inherited from class java.lang.Object

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

Constructor Detail

SceneServiceProvider

public SceneServiceProvider(GameClient gameClient)

Initializes a new SceneServiceProvider.

Parameters:

gameClient - The GameClient that owns this service provider

Since:

1.0.0

Method Detail

getScenes

public CompletableFuture<Set<InteractiveScene>> getScenes()

Retrieves all the scenes for the Interactive integration.

The result of the CompletableFuture may include checked exceptions that were thrown in the event that there was a problem with the reply from the Interactive service. Specifically, two types of checked exceptions may be thrown:

• InteractiveRequestNoReplyException may be thrown if no reply is received from the Interactive service.
• InteractiveReplyWithErrorException may be thrown if the reply received from the Interactive service contains an InteractiveError.

Considerations should be made for these possibilities when interpreting the results of the returned CompletableFuture.

Returns:

A CompletableFuture that when complete returns a Set of InteractiveScenes for the currently connected Interactive integration

Since:

1.0.0

See Also:

InteractiveScene

create

public CompletableFuture<Set<InteractiveScene>> create(InteractiveScene... scenes)

Creates one or more new scenes. Scene IDs MUST be unique and not already exist in the Interactive integration.

Scene objects may also optionally include controls to be set on the scene initially, rather than requiring further InteractiveMethod.CREATE_CONTROLS calls. If an initial set of controls are provided, they MUST be fully-qualified, tagged control objects.

The Interactive service will either create all scenes and controls, or fail in which case NONE of the scenes and controls provided will be created. In no case will the Interactive service create a subset of scenes and controls.

The result of the CompletableFuture may include checked exceptions that were thrown in the event that there was a problem with the reply from the Interactive service. Specifically, two types of checked exceptions may be thrown:

• InteractiveRequestNoReplyException may be thrown if no reply is received from the Interactive service.
• InteractiveReplyWithErrorException may be thrown if the reply received from the Interactive service contains an InteractiveError.

Considerations should be made for these possibilities when interpreting the results of the returned CompletableFuture.

Parameters:

scenes - An array of InteractiveScenes to be created

Returns:

A CompletableFuture that when complete returns a Set of newly created InteractiveScenes

Since:

1.0.0

See Also:

InteractiveScene

create

public CompletableFuture<Set<InteractiveScene>> create(Collection<InteractiveScene> scenes)

Creates one or more new scenes. Scene IDs MUST be unique and not already exist in the Interactive integration.

Scene objects may also optionally include controls to be set on the scene initially, rather than requiring further InteractiveMethod.CREATE_CONTROLS calls. If an initial set of controls are provided, they MUST be fully-qualified, tagged control objects.

The Interactive service will either create all scenes and controls, or fail in which case NONE of the scenes and controls provided will be created. In no case will the Interactive service create a subset of scenes and controls.

The result of the CompletableFuture may include checked exceptions that were thrown in the event that there was a problem with the reply from the Interactive service. Specifically, two types of checked exceptions may be thrown:

• InteractiveRequestNoReplyException may be thrown if no reply is received from the Interactive service.
• InteractiveReplyWithErrorException may be thrown if the reply received from the Interactive service contains an InteractiveError.

Considerations should be made for these possibilities when interpreting the results of the returned CompletableFuture.

Parameters:

scenes - A Collection of InteractiveScenes to be created

Returns:

A CompletableFuture that when complete returns a Set of newly created InteractiveScenes

Since:

1.0.0

See Also:

InteractiveScene

update

public CompletableFuture<Set<InteractiveScene>> update(InteractiveScene... scenes)

Updates scenes that already exist. The Interactive service will reply with a set of updated scenes.

The Interactive service will either update all the scenes provided, or fail in which case NONE of the scenes provided will be updated. In no case will the Interactive service apply updates to a subset of scenes.

The result of the CompletableFuture may include checked exceptions that were thrown in the event that there was a problem with the reply from the Interactive service. Specifically, two types of checked exceptions may be thrown:

• InteractiveRequestNoReplyException may be thrown if no reply is received from the Interactive service.
• InteractiveReplyWithErrorException may be thrown if the reply received from the Interactive service contains an InteractiveError.

Considerations should be made for these possibilities when interpreting the results of the returned CompletableFuture.

Parameters:

scenes - An array of InteractiveScenes to be updated

Returns:

A CompletableFuture that when complete returns a Set of updated InteractiveScenes

Since:

1.0.0

See Also:

InteractiveScene

update

public CompletableFuture<Set<InteractiveScene>> update(int priority,
                                                       InteractiveScene... scenes)

Updates scenes that already exist. The Interactive service will reply with a set of updated scenes.

The Interactive service will either update all the scenes provided, or fail in which case NONE of the scenes provided will be updated. In no case will the Interactive service apply updates to a subset of scenes.

The result of the CompletableFuture may include checked exceptions that were thrown in the event that there was a problem with the reply from the Interactive service. Specifically, two types of checked exceptions may be thrown:

• InteractiveRequestNoReplyException may be thrown if no reply is received from the Interactive service.
• InteractiveReplyWithErrorException may be thrown if the reply received from the Interactive service contains an InteractiveError.

Considerations should be made for these possibilities when interpreting the results of the returned CompletableFuture.

Parameters:

priority - The priority value for the update

scenes - An array of InteractiveScenes to be updated

Returns:

A CompletableFuture that when complete returns a Set of updated InteractiveScenes

Since:

1.0.0

See Also:

InteractiveScene

update

public CompletableFuture<Set<InteractiveScene>> update(Collection<InteractiveScene> scenes)

Updates scenes that already exist. The Interactive service will reply with a set of updated scenes with.

The Interactive service will either update all the scenes provided, or fail in which case NONE of the scenes provided will be updated. In no case will the Interactive service apply updates to a subset of scenes.

The result of the CompletableFuture may include checked exceptions that were thrown in the event that there was a problem with the reply from the Interactive service. Specifically, two types of checked exceptions may be thrown:

• InteractiveRequestNoReplyException may be thrown if no reply is received from the Interactive service.
• InteractiveReplyWithErrorException may be thrown if the reply received from the Interactive service contains an InteractiveError.

Considerations should be made for these possibilities when interpreting the results of the returned CompletableFuture.

Parameters:

scenes - A Collection of InteractiveScenes to be updated

Returns:

A CompletableFuture that when complete returns a Set of updated InteractiveScenes

Since:

1.0.0

See Also:

InteractiveScene

update

public CompletableFuture<Set<InteractiveScene>> update(int priority,
                                                       Collection<InteractiveScene> scenes)

Updates scenes that already exist. The Interactive service will reply with a set of updated scenes with.

The Interactive service will either update all the scenes provided, or fail in which case NONE of the scenes provided will be updated. In no case will the Interactive service apply updates to a subset of scenes.

The result of the CompletableFuture may include checked exceptions that were thrown in the event that there was a problem with the reply from the Interactive service. Specifically, two types of checked exceptions may be thrown:

• InteractiveRequestNoReplyException may be thrown if no reply is received from the Interactive service.
• InteractiveReplyWithErrorException may be thrown if the reply received from the Interactive service contains an InteractiveError.

Considerations should be made for these possibilities when interpreting the results of the returned CompletableFuture.

Parameters:

priority - The priority value for the update

scenes - A Collection of InteractiveScenes to be updated

Returns:

A CompletableFuture that when complete returns a Set of updated InteractiveScenes

Since:

1.0.0

See Also:

InteractiveScene

delete

public CompletableFuture<Boolean> delete(String sceneID)

Removes a scene from the Interactive integration, reassigning any groups who were on that scene to the default one. The server MAY not return an error if the scene to remove does not exist.

The result of the CompletableFuture may include checked exceptions that were thrown in the event that there was a problem with the reply from the Interactive service. Specifically, two types of checked exceptions may be thrown:

• InteractiveRequestNoReplyException may be thrown if no reply is received from the Interactive service.
• InteractiveReplyWithErrorException may be thrown if the reply received from the Interactive service contains an InteractiveError.

Considerations should be made for these possibilities when interpreting the results of the returned CompletableFuture.

Parameters:

sceneID - Identifier for an InteractiveScene to be deleted

Returns:

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

Since:

1.0.0

See Also:

InteractiveScene

delete

public CompletableFuture<Boolean> delete(String sceneID,
                                         String reassignSceneID)

Removes a scene from the Interactive integration, reassigning any groups who were on that scene to a different one. The server MAY not return an error if the scene to remove does not exist.

The result of the CompletableFuture may include checked exceptions that were thrown in the event that there was a problem with the reply from the Interactive service. Specifically, two types of checked exceptions may be thrown:

• InteractiveRequestNoReplyException may be thrown if no reply is received from the Interactive service.
• InteractiveReplyWithErrorException may be thrown if the reply received from the Interactive service contains an InteractiveError.

Considerations should be made for these possibilities when interpreting the results of the returned CompletableFuture.

Parameters:

sceneID - Identifier for an InteractiveScene to be deleted

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

See Also:

InteractiveScene