com.mixer.interactive.protocol

Class ReplyPacket

java.lang.Object

com.mixer.interactive.protocol.InteractivePacket

com.mixer.interactive.protocol.ReplyPacket

public class ReplyPacket
extends InteractivePacket

A ReplyPacket represents a reply to a request to perform an action.

Since:

1.0.0

Author:

Microsoft Corporation

See Also:

MethodPacket

Constructor Summary

Constructors

Constructor and Description
ReplyPacket(int id, com.google.gson.JsonElement result, InteractiveError error) Initializes a new ReplyPacket.

Method Summary

Modifier and Type	Method and Description
InteractiveError	getError() Returns the InteractiveError returned from the Interactive service if there was an error.
com.google.gson.JsonElement	getResult() Returns the result that was returned by the Interactive service for the request.
<T> T	getResultAs(Class<T> clazz) Returns the result of the request, parsed as an object of type T.
<T> T	getResultAs(Type type) Returns the result of the request, parsed as an object of type T.
boolean	hasError() Returns true if there was an error, false otherwise.
boolean	hasResult() Returns the result that was returned by the Interactive service for the request.

Methods inherited from class com.mixer.interactive.protocol.InteractivePacket

getPacketID, getSequenceNumber, getType, setSequenceNumber

Methods inherited from class java.lang.Object

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

Constructor Detail

ReplyPacket

public ReplyPacket(int id,
                   com.google.gson.JsonElement result,
                   InteractiveError error)

Initializes a new ReplyPacket.

Parameters:

id - Numeric identifier for this packet (should match the method packet identifier that resulted in this reply)

result - Unstructured result of the request returned by the Interactive service

error - InteractiveError that may be returned by the Interactive service

Since:

1.0.0

Method Detail

hasResult

public boolean hasResult()

Returns the result that was returned by the Interactive service for the request.

Returns:

true if a result object was returned from the Interactive service, false otherwise

Since:

1.0.0

getResult

public com.google.gson.JsonElement getResult()

Returns the result that was returned by the Interactive service for the request.

Returns:

The result that was returned by the Interactive service for the request

Since:

1.0.0

getResultAs

public <T> T getResultAs(Type type)

Returns the result of the request, parsed as an object of type T.

Type Parameters:

T - Class of object to be parsed from the reply

Parameters:

type - Type of object to be parsed from reply

Returns:

The result of the request, parsed as an object of type T

Since:

1.0.0

getResultAs

public <T> T getResultAs(Class<T> clazz)

Returns the result of the request, parsed as an object of type T.

Type Parameters:

T - Class of object to be parsed from the reply

Parameters:

clazz - Class of object to be parsed from the reply

Returns:

The result of the request, parsed as an object of type T

Since:

1.0.0

hasError

public boolean hasError()

Returns true if there was an error, false otherwise.

Returns:

true if there was an error, false otherwise

Since:

1.0.0

getError

public InteractiveError getError()

Returns the InteractiveError returned from the Interactive service if there was an error.

Returns:

The InteractiveError returned from the Interactive service if there was an error

Since:

1.0.0