Usage

Import

const WebSocketPlugin = cordova.websocket;

Connect to WebSocket

WebSocketPlugin.connect("wss://example.com/socket", ["protocol1", "protocol2"], customHeaders)
  .then(ws => {
    ws.onopen = (e) => console.log("Connected!", e);
    ws.onmessage = (e) => console.log("Message:", e.data);
    ws.onerror = (e) => console.error("Error:", e);
    ws.onclose = (e) => console.log("Closed:", e);

    ws.send("Hello from Cordova!");
    ws.close();
  })
  .catch(err => console.error("WebSocket connection failed:", err));

API Reference

Methods

• WebSocketPlugin.connect(url, protocols, headers)

  • Connects to a WebSocket server.
  • url: The WebSocket server URL.
  • protocols: (Optional) An array of subprotocol strings.
  • headers (object, optional): Custom headers as key-value pairs.
  • Returns: A Promise that resolves to a WebSocketInstance.

• WebSocketPlugin.listClients()

  • Lists all stored webSocket instance IDs.
  • Returns: Promisethat resolves to an array of instanceId strings.

• WebSocketPlugin.send(instanceId, message)

  • same as WebSocketInstance.send(message) but needs instanceId.
  • Returns: Promise that resolves.

• WebSocketPlugin.close(instanceId, code, reason)

  • same as WebSocketInstance.close(code, reason) but needs instanceId.
  • Returns: Promise that resolves.

• WebSocketInstance.send(message)

  • Sends a message to the server.
  • Throws an error if the connection is not open.

• WebSocketInstance.close(code, reason)

  • Closes the connection.
  • code: (Optional) If unspecified, a close code for the connection is automatically set: to 1000 for a normal closure, or otherwise to another standard value in the range 1001-1015 that indicates the actual reason the connection was closed.
  • reason: A string providing a custom WebSocket connection close reason (a concise human-readable prose explanation for the closure). The value must be no longer than 123 bytes (encoded in UTF-8).

Properties of WebSocketInstance

• onopen: Event listener for connection open.

• onmessage: Event listener for messages received.

• onclose: Event listener for connection close.

• onerror: Event listener for errors.

• readyState: (number) The state of the connection.

  • 0 (CONNECTING): Socket created, not yet open.
  • 1 (OPEN): Connection is open and ready.
  • 2 (CLOSING): Connection is closing.
  • 3 (CLOSED): Connection is closed or couldn't be opened.

• extensions: (string) Extensions negotiated by the server (usually empty or a list).