com.mixer.interactive.services

Class TransactionServiceProvider

java.lang.Object

com.mixer.interactive.services.AbstractServiceProvider

com.mixer.interactive.services.TransactionServiceProvider

public class TransactionServiceProvider
extends AbstractServiceProvider

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

Since:

1.0.0

Author:

Microsoft Corporation

See Also:

InteractiveTransaction

Field Summary

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

gameClient

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Boolean>	capture(String transactionID) Attempt to complete a spark transaction from the participant that initiated the transaction.

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

TransactionServiceProvider

public TransactionServiceProvider(GameClient gameClient)

Initializes a new TransactionServiceProvider.

Parameters:

gameClient - The GameClient that owns this service provider

Since:

1.0.0

Method Detail

capture

public CompletableFuture<Boolean> capture(String transactionID)

Attempt to complete a spark transaction from the participant that initiated the transaction. The Interactive service makes a best-effort to validate the charge before it’s created, blocking obviously invalid ones outright, but when possible the client SHOULD await a successful reply before effecting any associated action.

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:

transactionID - Identifier for a Spark transaction

Returns:

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

Since:

1.0.0

See Also:

InteractiveControlInput, InteractiveTransaction