メインコンテンツへスキップ

WebSocket

「WebSocket」クラスは、ページ内のWebSocket接続を表します。送受信されるデータを検査および操作する機能を提供します。

WebSocketフレームをインターセプトまたは変更したい場合は、WebSocketRouteの使用を検討してください。

メソッド​

isClosed​

v1.9より前に追加 webSocket.isClosed

Webソケットが閉じられたことを示します。

使用法

WebSocket.isClosed();

戻り値

url​

v1.9より前に追加 webSocket.url

WebSocketのURLが含まれます。

使用法

WebSocket.url();

戻り値

waitForFrameReceived​

追加されたバージョン: v1.10 webSocket.waitForFrameReceived

アクションを実行し、フレームが送信されるのを待ちます。`predicate`が指定されている場合、WebSocketFrameの値を`predicate`関数に渡し、`predicate(webSocketFrame)`が真値（truthy value）を返すまで待機します。フレームが受信される前にWebSocketまたはページが閉じられた場合、エラーをスローします。

使用法

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

引数

  • options WebSocket.WaitForFrameReceivedOptions (オプション)

    • setPredicate Predicate<WebSocketFrame> (オプション)追加されたバージョン: v1.9#

      WebSocketFrameオブジェクトを受け取り、待機が解決されるべきときに真値（truthy value）を返します。

    • setTimeout double (オプション)追加されたバージョン: v1.9#

      待機する最大時間（ミリ秒単位）。デフォルトは`30000`（30秒）です。`0`を渡すとタイムアウトが無効になります。デフォルト値はBrowserContext.setDefaultTimeout()を使用して変更できます。

  • callback Runnable追加されたバージョン: v1.9#

    イベントをトリガーするアクションを実行するコールバック。

戻り値

waitForFrameSent​

追加されたバージョン: v1.10 webSocket.waitForFrameSent

アクションを実行し、フレームが送信されるのを待ちます。`predicate`が指定されている場合、WebSocketFrameの値を`predicate`関数に渡し、`predicate(webSocketFrame)`が真値（truthy value）を返すまで待機します。フレームが送信される前にWebSocketまたはページが閉じられた場合、エラーをスローします。

使用法

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

引数

  • options WebSocket.WaitForFrameSentOptions (オプション)

    • setPredicate Predicate<WebSocketFrame> (オプション)追加されたバージョン: v1.9#

      WebSocketFrameオブジェクトを受け取り、待機が解決されるべきときに真値（truthy value）を返します。

    • setTimeout double (オプション)追加されたバージョン: v1.9#

      待機する最大時間（ミリ秒単位）。デフォルトは`30000`（30秒）です。`0`を渡すとタイムアウトが無効になります。デフォルト値はBrowserContext.setDefaultTimeout()を使用して変更できます。

  • callback Runnable追加されたバージョン: v1.9#

    イベントをトリガーするアクションを実行するコールバック。

戻り値

イベント​

onClose(handler)​

v1.9より前に追加 webSocket.onClose(handler)

WebSocketが閉じられたときに発生します。

使用法

WebSocket.onClose(handler)

イベントデータ

onFrameReceived(handler)​

追加されたバージョン: v1.9 webSocket.onFrameReceived(handler)

WebSocketがフレームを受信したときに発生します。

使用法

WebSocket.onFrameReceived(handler)

イベントデータ

onFrameSent(handler)​

追加されたバージョン: v1.9 webSocket.onFrameSent(handler)

WebSocketがフレームを送信したときに発生します。

使用法

WebSocket.onFrameSent(handler)

イベントデータ

onSocketError(handler)​

追加されたバージョン: v1.9 webSocket.onSocketError(handler)

WebSocketでエラーが発生したときに発生します。

使用法

WebSocket.onSocketError(handler)

イベントデータ