WebSocket

The WebSocket class represents websocket connections in the page.

• WebSocket.onClose(handler)
• WebSocket.onFrameReceived(handler)
• WebSocket.onFrameSent(handler)
• WebSocket.onSocketError(handler)
• WebSocket.isClosed()
• WebSocket.url()
• WebSocket.waitForFrameReceived([options], callback)
• WebSocket.waitForFrameSent([options], callback)

WebSocket.onClose(handler)

Added in: v1.8

• type: <WebSocket>

Fired when the websocket closes.

WebSocket.onFrameReceived(handler)

Added in: v1.9

• type: <WebSocketFrame>

Fired when the websocket receives a frame.

WebSocket.onFrameSent(handler)

Added in: v1.9

• type: <WebSocketFrame>

Fired when the websocket sends a frame.

WebSocket.onSocketError(handler)

Added in: v1.9

• type: <String>

Fired when the websocket has an error.

WebSocket.isClosed()

Added in: v1.8

• returns: <boolean>#

Indicates that the web socket has been closed.

WebSocket.url()

Added in: v1.8

• returns: <String>#

Contains the URL of the WebSocket.

WebSocket.waitForFrameReceived([options], callback)

Added in: v1.10

• options <WebSocket.WaitForFrameReceivedOptions>
  • setPredicate <Predicate<WebSocketFrame>> Receives the WebSocketFrame object and resolves to truthy value when the waiting should resolve. Added in: v1.9#
  • setTimeout <double> Maximum time to wait for in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout(timeout). Added in: v1.9#
• callback <Runnable> Callback that performs the action triggering the event. Added in: v1.9#
• returns: <WebSocketFrame>#

Performs action and waits for a frame to be sent. If predicate is provided, it passes WebSocketFrame value into the predicate function and waits for predicate(webSocketFrame) to return a truthy value. Will throw an error if the WebSocket or Page is closed before the frame is received.

WebSocket.waitForFrameSent([options], callback)

Added in: v1.10

• options <WebSocket.WaitForFrameSentOptions>
  • setPredicate <Predicate<WebSocketFrame>> Receives the WebSocketFrame object and resolves to truthy value when the waiting should resolve. Added in: v1.9#
  • setTimeout <double> Maximum time to wait for in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout(timeout). Added in: v1.9#
• callback <Runnable> Callback that performs the action triggering the event. Added in: v1.9#
• returns: <WebSocketFrame>#

Performs action and waits for a frame to be sent. If predicate is provided, it passes WebSocketFrame value into the predicate function and waits for predicate(webSocketFrame) to return a truthy value. Will throw an error if the WebSocket or Page is closed before the frame is sent.