public class ControlServiceProvider extends AbstractServiceProvider
InteractiveGroup
gameClient
Constructor and Description |
---|
ControlServiceProvider(GameClient gameClient)
Initializes a new
ControlServiceProvider . |
equals, hashCode
public ControlServiceProvider(GameClient gameClient)
ControlServiceProvider
.gameClient
- The GameClient
that owns this service providerpublic 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
.
CompletableFuture
that when complete returns a Set
of
InteractiveControls
for the currently connected Interactive integrationInteractiveControl
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
.
controls
- An array of InteractiveControls
to be createdCompletableFuture
that when complete returns a Map
containing mappings of
InteractiveControls
to the respective CompletableFuture
holding the result
of the request.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
.
controls
- A Collection
of InteractiveControls
to be createdCompletableFuture
that when complete returns a Map
containing mappings of
InteractiveControls
to the respective CompletableFuture
holding the result
of the request.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
.
controls
- An array of InteractiveControls
to be updatedCompletableFuture
that when complete returns a Map
containing mappings of
InteractiveControls
to the respective CompletableFuture
holding the result
of the request.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
.
priority
- The priority value for the updatecontrols
- An array of InteractiveControls
to be updatedCompletableFuture
that when complete returns a Map
containing mappings of
InteractiveControls
to the respective CompletableFuture
holding the result
of the request.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
.
controls
- A Collection
of InteractiveControls
to be updatedCompletableFuture
that when complete returns a Map
containing mappings of
InteractiveControls
to the respective CompletableFuture
holding the result
of the request.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
.
priority
- The priority value for the updatecontrols
- A Collection
of InteractiveControls
to be updatedCompletableFuture
that when complete returns a Map
containing mappings of
InteractiveControls
to the respective CompletableFuture
holding the result
of the request.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
.
controls
- An array of InteractiveControls
to be deletedCompletableFuture
that when complete returns a Map
containing mappings of
InteractiveControls
to the respective CompletableFuture
holding the result
of the request.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
.
controls
- A Collection
of InteractiveControls
to be deletedCompletableFuture
that when complete returns a Map
containing mappings of
InteractiveControls
to the respective CompletableFuture
holding the result
of the request.Copyright © 2018. All rights reserved.