com.mixer.interactive.event.connection

Class ConnectionClosedEvent

java.lang.Object

com.mixer.interactive.event.InteractiveEvent

com.mixer.interactive.event.connection.ConnectionEvent

com.mixer.interactive.event.connection.ConnectionClosedEvent

public class ConnectionClosedEvent
extends ConnectionEvent

Interactive event posted when a websocket connection to the Interactive service is closed.

Since:

1.0.0

Author:

Microsoft Corporation

Constructor Summary

Constructors

Constructor and Description
ConnectionClosedEvent(Number projectVersionID, URI interactiveHostURI, Number code, String message, boolean closedRemotely) Initializes a new ConnectionClosedEvent.

Method Summary

Modifier and Type	Method and Description
Number	getStatusCode() Returns the HTTP status code returned when the connected was closed.
String	getStatusMessage() Returns the HTTP status message returned when the connection was closed.
boolean	wasClosedRemotely() Returnstrue if the connection was closed remotely, false otherwise.

Methods inherited from class com.mixer.interactive.event.connection.ConnectionEvent

getInteractiveHostURI, getProjectVersionID

Methods inherited from class com.mixer.interactive.event.InteractiveEvent

getRequestID, setRequestID

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectionClosedEvent

public ConnectionClosedEvent(Number projectVersionID,
                             URI interactiveHostURI,
                             Number code,
                             String message,
                             boolean closedRemotely)

Initializes a new ConnectionClosedEvent.

Parameters:

projectVersionID - The project version ID for the Interactive integration

interactiveHostURI - URI for the connected Interactive service host

code - HTTP status code

message - HTTP status message

closedRemotely - true if the connected was closed remotely, false otherwise

Since:

1.0.0

See Also:

InteractiveWebSocketClient.onClose(int, String, boolean)

Method Detail

getStatusCode

public Number getStatusCode()

Returns the HTTP status code returned when the connected was closed.

Returns:

The HTTP status code returned when the connected was closed

Since:

1.0.0

getStatusMessage

public String getStatusMessage()

Returns the HTTP status message returned when the connection was closed.

Returns:

The HTTP status message returned when the connection was closed

Since:

1.0.0

wasClosedRemotely

public boolean wasClosedRemotely()

Returnstrue if the connection was closed remotely, false otherwise.

Returns:

true if the connection was closed remotely, false otherwise

Since:

1.0.0