Methods

close()

Request to close down the WebSocket connection.

init(configuration, id, capability) → {Promise}

Initialize the WebSocket connection based on configuration properties.

Parameters:

Name	Type	Default	Description
configuration	Object		Configuration object used in construction WebSocket endpoint URL based on properties.
id	String		Optional identifier for the shared object connection instance. Needs to be unique. Autogenerated if left undefined.
capability	Integer	2	Optional capability enum for connection. 2 = Shared Object + WebSocket. 4 = Shared Object + RTC.

Returns:

Promise