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

WebSocket

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

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

メソッド​

isClosed​

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

WebSocket が閉じられたことを示します。

使い方

WebSocket.isClosed();

戻り値

url​

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

WebSocket の URL が含まれています。

使い方

WebSocket.url();

戻り値

waitForFrameReceived​

追加: v1.10 webSocket.waitForFrameReceived

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

使い方

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

引数

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

    • setPredicate Predicate<WebSocketFrame> (オプション)追加: v1.9#

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

    • setTimeout double (オプション)追加: v1.9#

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

  • callback Runnable追加: v1.9#

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

戻り値

waitForFrameSent​

追加: v1.10 webSocket.waitForFrameSent

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

使い方

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

引数

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

    • setPredicate Predicate<WebSocketFrame> (オプション)追加: v1.9#

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

    • 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)

イベントデータ