Skip to main content

WebSocketCloseEvent

Class

Event type for WebSocket close events.

  • Snapchat: not supported
  • SPECS: fully supported
  • Camera Kit Web: fully supported
  • Camera Kit Mobile: fully supported
  • SnapchatNot supported — Available on SPECS and Camera Kit only
  • SPECSFully supported
  • Camera Kit WebFully supported
  • Camera Kit MobileFully supported

Platform details

  • Snapchat — Not supported — Available on SPECS and Camera Kit only.

  • SPECS — Fully supported.

  • Camera Kit Web — Fully supported.

  • Camera Kit Mobile — Fully supported.

Event type for WebSocket close events. This event indicates when the WebSocket connection has been closed. Listen for this event by using addEventListener with close, or by setting the onclose property.

Index

Example

websocket.onclose = (event) => {
print("The connection has been closed.");
};

Extends

Properties

code

readonly code: number

SPECSCamera Kit

Returns an unsigned short indicating the close code sent by the server.

Status CodeMeaningDescription
0–999Not used.
1000Normal ClosureThe connection successfully completed the purpose for which it was created.
1001Going AwayThe endpoint is going away, either because of a server failure or because the browser is navigating away from the page that opened the connection.
1002Protocol errorThe endpoint is terminating the connection due to a protocol error.
1003Unsupported DataThe connection is being terminated because the endpoint received data of a type it cannot accept. (For example, a text-only endpoint received binary data.)
1004ReservedReserved. A meaning might be defined in the future.
1005No Status RcvdReserved. Indicates that no status code was provided even though one was expected.
1006Abnormal ClosureReserved. Indicates that a connection was closed abnormally (that is, with no close frame being sent) when a status code is expected.
1007Invalid frame payload dataThe endpoint is terminating the connection because a message was received that contained inconsistent data (e.g., non-UTF-8 data within a text message).
1008Policy ViolationThe endpoint is terminating the connection because it received a message that violates its policy. This is a generic status code, used when codes 1003 and 1009 are not suitable.
1009Message Too BigThe endpoint is terminating the connection because a data frame was received that is too large.
1010Mandatory Ext.The client is terminating the connection because it expected the server to negotiate one or more extensions, but the server didn't.
1011Internal ErrorThe server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request.
1012Service RestartThe server is terminating the connection because it is restarting.
1013Try Again LaterThe server is terminating the connection due to a temporary condition, e.g., it is overloaded and is casting off some of its clients.
1014Bad GatewayThe server was acting as a gateway or proxy and received an invalid response from the upstream server. This is similar to 502 HTTP Status Code.
1015TLS handshakeReserved. Indicates that the connection was closed due to a failure to perform a TLS handshake (e.g., the server certificate can't be verified).
1016–2999For definition by future revisions of the WebSocket Protocol specification, and for definition by extension specifications.
3000–3999For use by libraries, frameworks, and applications. These status codes are registered directly with IANA. The interpretation of these codes is undefined by the WebSocket protocol.
4000–4999For private use, and thus can't be registered.

reason

readonly reason: string

SPECSCamera Kit

The reason the WebSocket connection was closed.


wasClean

readonly wasClean: boolean

SPECSCamera Kit

True if the socket connection was closed without error.

Methods

getTypeName()

static getTypeName(): TypeName<WebSocketCloseEvent>

SPECSCamera Kit

Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().

Returns

TypeName<WebSocketCloseEvent>

Overrides

ScriptObject.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

ScriptObject.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object matches or derives from the passed in type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

ScriptObject.isOfType


isSame()

isSame(other): boolean

Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

ScriptObject.isSame