com.mixer.interactive.services

Class GroupServiceProvider

java.lang.Object

com.mixer.interactive.services.AbstractServiceProvider

com.mixer.interactive.services.GroupServiceProvider

public class GroupServiceProvider
extends AbstractServiceProvider

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

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
GroupServiceProvider(GameClient gameClient) Initializes a new GroupServiceProvider.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Boolean>	create(Collection<InteractiveGroup> groups) Creates one or more new groups.
CompletableFuture<Boolean>	create(InteractiveGroup... groups) Creates one or more new groups.
CompletableFuture<Boolean>	delete(String groupID) Removes a group from the Interactive integration, reassigning any participants who were in that group to the default group.
CompletableFuture<Boolean>	delete(String groupID, String reassignGroupID) Removes a group from the Interactive integration, reassigning any participants who were in that group to a different one.
CompletableFuture<Set<InteractiveGroup>>	getGroups() Retrieves all the groups connected to the Interactive integration.
CompletableFuture<Set<InteractiveGroup>>	update(Collection<InteractiveGroup> groups) Bulk-updates groups that already exist.
CompletableFuture<Set<InteractiveGroup>>	update(int priority, Collection<InteractiveGroup> groups) Bulk-updates groups that already exist.
CompletableFuture<Set<InteractiveGroup>>	update(InteractiveGroup... groups) Bulk-updates groups that already exist.
CompletableFuture<Set<InteractiveGroup>>	update(int priority, InteractiveGroup... groups) Bulk-updates groups 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

GroupServiceProvider

public GroupServiceProvider(GameClient gameClient)

Initializes a new GroupServiceProvider.

Parameters:

gameClient - The GameClient that owns this service provider

Since:

1.0.0

Method Detail

getGroups

public CompletableFuture<Set<InteractiveGroup>> getGroups()

Retrieves all the groups connected to 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 InteractiveGroups for the connected Interactive integration

Since:

1.0.0

See Also:

InteractiveGroup

create

public CompletableFuture<Boolean> create(InteractiveGroup... groups)

Creates one or more new groups. Each group may have an initial scene set, however if one is not set the Interactive service will assign the group to the default scene. Group 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:

groups - An array of InteractiveGroups to be created

Returns:

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

Since:

1.0.0

See Also:

InteractiveGroup

create

public CompletableFuture<Boolean> create(Collection<InteractiveGroup> groups)

Creates one or more new groups. Each group may have an initial scene set, however if one is not set the Interactive service will assign the group to the default scene. Group 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:

groups - A Collection of InteractiveGroups to be created

Returns:

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

Since:

1.0.0

See Also:

InteractiveGroup

update

public CompletableFuture<Set<InteractiveGroup>> update(InteractiveGroup... groups)

Bulk-updates groups that already exist. The Interactive service will reply with a set of updated groups.

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

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:

groups - An array of InteractiveGroups to be updated

Returns:

A CompletableFuture that when complete returns a Set of updated InteractiveGroups

Since:

1.0.0

See Also:

InteractiveGroup

update

public CompletableFuture<Set<InteractiveGroup>> update(int priority,
                                                       InteractiveGroup... groups)

Bulk-updates groups that already exist. The Interactive service will reply with a set of updated groups.

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

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

groups - An array of InteractiveGroups to be updated

Returns:

A CompletableFuture that when complete returns a Set of updated InteractiveGroups

Since:

1.0.0

See Also:

InteractiveGroup

update

public CompletableFuture<Set<InteractiveGroup>> update(Collection<InteractiveGroup> groups)

Bulk-updates groups that already exist. The Interactive service will reply with a set of updated groups.

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

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:

groups - A Collection of InteractiveGroups to be updated

Returns:

A CompletableFuture that when complete returns a Set of updated InteractiveGroups

Since:

1.0.0

See Also:

InteractiveGroup

update

public CompletableFuture<Set<InteractiveGroup>> update(int priority,
                                                       Collection<InteractiveGroup> groups)

Bulk-updates groups that already exist. The Interactive service will reply with a set of updated groups.

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

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

groups - A Collection of InteractiveGroups to be updated

Returns:

A CompletableFuture that when complete returns a Set of updated InteractiveGroups

Since:

1.0.0

See Also:

InteractiveGroup

delete

public CompletableFuture<Boolean> delete(String groupID)

Removes a group from the Interactive integration, reassigning any participants who were in that group to the default group. The server MAY not return an error if the group 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:

groupID - Identifier for an InteractiveGroup to be deleted

Returns:

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

Since:

1.0.0

See Also:

InteractiveGroup

delete

public CompletableFuture<Boolean> delete(String groupID,
                                         String reassignGroupID)

Removes a group from the Interactive integration, reassigning any participants who were in that group to a different one. The server MAY not return an error if the group 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:

groupID - Identifier for an InteractiveGroup to be deleted

reassignGroupID - Identifier for the InteractiveGroup participants 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

See Also:

InteractiveGroup