WebSocket

WebSocket 類別代表頁面中的 websocket 連線。

---

方法

isClosed

在 v1.9 之前加入 webSocket.isClosed

表示 web socket 是否已關閉。

用法

WebSocket.isClosed();

回傳

• boolean#

---

url

在 v1.9 之前加入 webSocket.url

包含 WebSocket 的 URL。

用法

WebSocket.url();

回傳

• String#

---

waitForFrameReceived

在 v1.10 版本加入 webSocket.waitForFrameReceived

執行動作並等待接收 frame。如果提供 predicate，它會將 WebSocketFrame 值傳遞到 predicate 函數中，並等待 predicate(webSocketFrame) 回傳 truthy 值。如果在接收到 frame 之前 WebSocket 或 Page 關閉，則會拋出錯誤。

用法

WebSocket.waitForFrameReceived(callback);
WebSocket.waitForFrameReceived(callback, options);

參數

• options WebSocket.WaitForFrameReceivedOptions (可選)

  • setPredicate Predicate<WebSocketFrame> (可選)在 v1.9 版本加入#

    接收 WebSocketFrame 物件，並在等待應該解析時解析為 truthy 值。

  • setTimeout double (可選)在 v1.9 版本加入#

    等待的最長時間，以毫秒為單位。預設值為 30000 (30 秒)。傳遞 0 以停用逾時。預設值可以使用 BrowserContext.setDefaultTimeout() 變更。

• callback Runnable在 v1.9 版本加入#

  執行觸發事件的動作的回呼。

回傳

• WebSocketFrame#

---

waitForFrameSent

在 v1.10 版本加入 webSocket.waitForFrameSent

執行動作並等待 frame 被傳送。如果提供 predicate，它會將 WebSocketFrame 值傳遞到 predicate 函數中，並等待 predicate(webSocketFrame) 回傳 truthy 值。如果在傳送 frame 之前 WebSocket 或 Page 關閉，則會拋出錯誤。

用法

WebSocket.waitForFrameSent(callback);
WebSocket.waitForFrameSent(callback, options);

參數

• options WebSocket.WaitForFrameSentOptions (可選)

  • setPredicate Predicate<WebSocketFrame> (可選)在 v1.9 版本加入#

    接收 WebSocketFrame 物件，並在等待應該解析時解析為 truthy 值。

  • setTimeout double (可選)在 v1.9 版本加入#

    等待的最長時間，以毫秒為單位。預設值為 30000 (30 秒)。傳遞 0 以停用逾時。預設值可以使用 BrowserContext.setDefaultTimeout() 變更。

• callback Runnable在 v1.9 版本加入#

  執行觸發事件的動作的回呼。

回傳

• WebSocketFrame#

---

事件

onClose(handler)

在 v1.9 之前加入 webSocket.onClose(handler)

當 websocket 關閉時觸發。

用法

WebSocket.onClose(handler)

事件資料

• WebSocket

---

onFrameReceived(handler)

在 v1.9 版本加入 webSocket.onFrameReceived(handler)

當 websocket 接收到 frame 時觸發。

用法

WebSocket.onFrameReceived(handler)

事件資料

• WebSocketFrame

---

onFrameSent(handler)

在 v1.9 版本加入 webSocket.onFrameSent(handler)

當 websocket 傳送 frame 時觸發。

用法

WebSocket.onFrameSent(handler)

事件資料

• WebSocketFrame

---

onSocketError(handler)

在 v1.9 版本加入 webSocket.onSocketError(handler)

當 websocket 發生錯誤時觸發。

用法

WebSocket.onSocketError(handler)

事件資料

• String