window.WebSocket

WebSocket(url, protocols)

WebSocket provides the API for creating and managing a WebSocket connection to a server, as well as for sending and receiving data on the connection. In order to leverage WebSocket, update the manifest.json with the network.domains permission shown in the example section

Example:

{
  "permissions": {
      "network": {
          "domains": [
              "https://www.adobe.com",
              "https://*.adobeprerelease.com",
              "wss://*.myplugin.com"
          ]
      }
  }
}
Copied to your clipboard
{
  "permissions": {
      "network": {
          "domains": [
              "https://www.adobe.com",
              "https://*.adobeprerelease.com",
              "wss://*.myplugin.com"
          ]
      }
  }
}

Limitation:From UXP v7.4.0 onwards `permissions.network.domains` does not support WildCards in top-level domains. Example: ```json "domains": [ "https://www.adobe.*", "https://www.*" ] ```

Throws:

Error If invalid url or protocols is passed

Param	Type	Description
url	`string`	URL to which to connect; this should be the URL to which the WebSocket server will respond.
protocols	`string` \| `Array<string>`	Either a single protocol string or an array of protocol strings.

Example

var ws = new WebSocket("wss://demos.kaazing.com/echo","wss");
Copied to your clipboard
var ws = new WebSocket("wss://demos.kaazing.com/echo","wss");

readyState : `number`

Read only Current state of the WebSocket connection. One of the following values:

Number	Status	Description
0	CONNECTING	Socket has been created. The connection is not yet opened.
1	OPEN	Connection is open and ready to communicate.
2	CLOSING	Connection is in the process of closing.
3	CLOSED	Connection is closed or couldn't be opened.

url : `string`

Read only URL of the WebSocket as resolved by the constructor.

protocol : `string`

Name of the sub-protocol the server selected. This will be one of the strings specified in the protocols parameter when creating the WebSocket object. It returns an empty string if no connection is established.

bufferedAmount : `number`

Read only Number of bytes of data that have been queued using calls to send() but not yet transmitted to the network. This value resets to zero once all queued data has been sent. This value does not reset to zero when the connection is closed; If you keep calling send(), this will continue to climb.

binaryType : `string`

Type of the binary data being received over WebSocket connection. Available binary types: "blob", "arraybuffer".

send(data)

Enqueues the specified data to be transmitted to the other end over the WebSocket connection, increasing the value of bufferedAmount by the number of bytes needed to contain the data. If the data can't be sent (for example, because it needs to be buffered but the buffer is full), the socket is closed automatically.

Param	Type	Description
data	`string` \| `ArrayBuffer` \| `ArrayBufferView`	Data to send to the server.

Example

ws.send(new Float32Array([ 5, 2, 1, 3, 6, -1 ]))
Copied to your clipboard
ws.send(new Float32Array([ 5, 2, 1, 3, 6, -1 ]))

Example

ws.send(new Int32Array([5,-1]).buffer)
Copied to your clipboard
ws.send(new Int32Array([5,-1]).buffer)

close([code], [reason])

Closes the websocket connection.

Throws:

Error If invalid code or reason is passed

Param	Type	Default	Description
[code]	`number`	`1000`	Integer value as per https://developer.mozilla.org/en-US/docs/Web/API/WebSocket#close().
[reason]	`string`		Human-readable string explaining why the connection is closing. The default value is "".