com.mixer.interactive.protocol

Class MethodPacket

java.lang.Object

com.mixer.interactive.protocol.InteractivePacket

com.mixer.interactive.protocol.MethodPacket

public class MethodPacket
extends InteractivePacket

A MethodPacket represents a request for the recipient (which could either be the Interactive service or a client) to perform an action. The action varies depending on the InteractiveMethod that was the subject of the request.

Since:

1.0.0

Author:

Microsoft Corporation

See Also:

InteractiveMethod, ReplyPacket

Constructor Summary

Constructors

Constructor and Description
MethodPacket(int id, InteractiveMethod method, com.google.gson.JsonElement params) Initializes a new MethodPacket.
MethodPacket(int id, InteractiveMethod method, com.google.gson.JsonElement params, Boolean discard) Initializes a new MethodPacket.
MethodPacket(int id, String method, com.google.gson.JsonElement params) Initializes a new MethodPacket.
MethodPacket(int id, String method, com.google.gson.JsonElement params, Boolean discard) Initializes a new MethodPacket.

Method Summary

Modifier and Type	Method and Description
boolean	getDiscard() Returns whether or not this request can be discarded (a reply is not required).
InteractiveMethod	getMethod() Retrieves the InteractiveMethod to call on the Interactive service.
String	getMethodName() Retrieves the method name to call on the Interactive service.
com.google.gson.JsonElement	getRequestParameters() Retrieves the parameters 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

MethodPacket

public MethodPacket(int id,
                    InteractiveMethod method,
                    com.google.gson.JsonElement params)

Initializes a new MethodPacket.

Parameters:

id - Numeric identifier for this packet

method - The name of the method to call on the Interactive service

params - An object of named arguments to pass as parameters to the Interactive service

Since:

1.0.0

MethodPacket

public MethodPacket(int id,
                    String method,
                    com.google.gson.JsonElement params)

Initializes a new MethodPacket.

Parameters:

id - Numeric identifier for this packet

method - The name of the method to call on the Interactive service

params - An object of named arguments to pass as parameters to the Interactive service

Since:

1.0.0

MethodPacket

public MethodPacket(int id,
                    InteractiveMethod method,
                    com.google.gson.JsonElement params,
                    Boolean discard)

Initializes a new MethodPacket.

Parameters:

id - Numeric identifier for this packet

method - The name of the method to call on the Interactive service

params - An object of named arguments to pass as parameters to the Interactive service

discard - true if this request can be discarded (a reply is not required), false otherwise

Since:

1.0.0

MethodPacket

public MethodPacket(int id,
                    String method,
                    com.google.gson.JsonElement params,
                    Boolean discard)

Initializes a new MethodPacket.

Parameters:

id - Numeric identifier for this packet

method - The name of the method to call on the Interactive service

params - An object of named arguments to pass as parameters to the Interactive service

discard - true if this request can be discarded (a reply is not required), false otherwise

Since:

1.0.0

Method Detail

getMethod

public InteractiveMethod getMethod()

Retrieves the InteractiveMethod to call on the Interactive service.

Returns:

The InteractiveMethod to call on the Interactive service

Since:

1.0.0

getMethodName

public String getMethodName()

Retrieves the method name to call on the Interactive service.

Returns:

The method name to call on the Interactive service

Since:

1.0.0

getRequestParameters

public com.google.gson.JsonElement getRequestParameters()

Retrieves the parameters for the request.

Returns:

An object of named arguments to pass as parameters to the Interactive service

Since:

1.0.0

getDiscard

public boolean getDiscard()

Returns whether or not this request can be discarded (a reply is not required).

Returns:

true if this request can be discarded (a reply is not required), false otherwise

Since:

1.0.0