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

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)が真値を返すのを待ちます。フレームを受信する前に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

アクションを実行し、フレームが送信されるのを待ちます。predicateが指定されている場合、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)

Web ソケットが閉じられたときに発生します。

使用法

WebSocket.onClose(handler)

イベントデータ

onFrameReceived(handler)​

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

Web ソケットがフレームを受信したときに発生します。

使用法

WebSocket.onFrameReceived(handler)

イベントデータ

onFrameSent(handler)​

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

Web ソケットがフレームを送信したときに発生します。

使用法

WebSocket.onFrameSent(handler)

イベントデータ

onSocketError(handler)​

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

Web ソケットにエラーが発生したときに発生します。

使用法

WebSocket.onSocketError(handler)

イベントデータ