com.mixer.interactive.services

Class ControlServiceProvider

java.lang.Object

com.mixer.interactive.services.AbstractServiceProvider

com.mixer.interactive.services.ControlServiceProvider

public class ControlServiceProvider
extends AbstractServiceProvider

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

Since:

1.0.0

Author:

Microsoft Corporation

See Also:

InteractiveGroup

Field Summary

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

gameClient

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Map<InteractiveControl,CompletableFuture<Boolean>>>	create(Collection<InteractiveControl> controls) Creates one or more new controls.
CompletableFuture<Map<InteractiveControl,CompletableFuture<Boolean>>>	create(InteractiveControl... controls) Creates one or more new controls.
CompletableFuture<Map<InteractiveControl,CompletableFuture<Boolean>>>	delete(Collection<InteractiveControl> controls) Deletes one or more new controls.
CompletableFuture<Map<InteractiveControl,CompletableFuture<Boolean>>>	delete(InteractiveControl... controls) Deletes one or more new controls.
CompletableFuture<Set<InteractiveControl>>	getControls() Retrieves all the controls for the Interactive integration.
CompletableFuture<Map<InteractiveControl,CompletableFuture<Set<InteractiveControl>>>>	update(Collection<InteractiveControl> controls) Updates one or more new controls.
CompletableFuture<Map<InteractiveControl,CompletableFuture<Set<InteractiveControl>>>>	update(int priority, Collection<InteractiveControl> controls) Updates one or more new controls.
CompletableFuture<Map<InteractiveControl,CompletableFuture<Set<InteractiveControl>>>>	update(InteractiveControl... controls) Updates one or more new controls.
CompletableFuture<Map<InteractiveControl,CompletableFuture<Set<InteractiveControl>>>>	update(int priority, InteractiveControl... controls) Updates one or more new controls.

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

ControlServiceProvider

public ControlServiceProvider(GameClient gameClient)

Initializes a new ControlServiceProvider.

Parameters:

gameClient - The GameClient that owns this service provider

Since:

1.0.0

Method Detail

getControls

public final CompletableFuture<Set<InteractiveControl>> getControls()

Retrieves all the controls 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 InteractiveControls for the currently connected Interactive integration

Since:

2.0.0

See Also:

InteractiveControl

create

public CompletableFuture<Map<InteractiveControl,CompletableFuture<Boolean>>> create(InteractiveControl... controls)

Creates one or more new controls. Control IDs MUST be unique and not already exist in 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.

Parameters:

controls - An array of InteractiveControls to be created

Returns:

A CompletableFuture that when complete returns a Map containing mappings of InteractiveControls to the respective CompletableFuture holding the result of the request.

Since:

2.0.0

create

public CompletableFuture<Map<InteractiveControl,CompletableFuture<Boolean>>> create(Collection<InteractiveControl> controls)

Creates one or more new controls. Control IDs MUST be unique and not already exist in 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.

Parameters:

controls - A Collection of InteractiveControls to be created

Returns:

A CompletableFuture that when complete returns a Map containing mappings of InteractiveControls to the respective CompletableFuture holding the result of the request.

Since:

2.0.0

update

public CompletableFuture<Map<InteractiveControl,CompletableFuture<Set<InteractiveControl>>>> update(InteractiveControl... controls)

Updates one or more new 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:

controls - An array of InteractiveControls to be updated

Returns:

A CompletableFuture that when complete returns a Map containing mappings of InteractiveControls to the respective CompletableFuture holding the result of the request.

Since:

2.0.0

update

public CompletableFuture<Map<InteractiveControl,CompletableFuture<Set<InteractiveControl>>>> update(int priority,
                                                                                                    InteractiveControl... controls)

Updates one or more new 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:

priority - The priority value for the update

controls - An array of InteractiveControls to be updated

Returns:

A CompletableFuture that when complete returns a Map containing mappings of InteractiveControls to the respective CompletableFuture holding the result of the request.

Since:

2.0.0

update

public CompletableFuture<Map<InteractiveControl,CompletableFuture<Set<InteractiveControl>>>> update(Collection<InteractiveControl> controls)

Updates one or more new 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:

controls - A Collection of InteractiveControls to be updated

Returns:

A CompletableFuture that when complete returns a Map containing mappings of InteractiveControls to the respective CompletableFuture holding the result of the request.

Since:

2.0.0

update

public CompletableFuture<Map<InteractiveControl,CompletableFuture<Set<InteractiveControl>>>> update(int priority,
                                                                                                    Collection<InteractiveControl> controls)

Updates one or more new 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:

priority - The priority value for the update

controls - A Collection of InteractiveControls to be updated

Returns:

A CompletableFuture that when complete returns a Map containing mappings of InteractiveControls to the respective CompletableFuture holding the result of the request.

Since:

2.0.0

delete

public CompletableFuture<Map<InteractiveControl,CompletableFuture<Boolean>>> delete(InteractiveControl... controls)

Deletes one or more new 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:

controls - An array of InteractiveControls to be deleted

Returns:

A CompletableFuture that when complete returns a Map containing mappings of InteractiveControls to the respective CompletableFuture holding the result of the request.

Since:

2.0.0

delete

public CompletableFuture<Map<InteractiveControl,CompletableFuture<Boolean>>> delete(Collection<InteractiveControl> controls)

Deletes one or more new 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:

controls - A Collection of InteractiveControls to be deleted

Returns:

A CompletableFuture that when complete returns a Map containing mappings of InteractiveControls to the respective CompletableFuture holding the result of the request.

Since:

2.0.0