Package com.microsoft.playwright

Interface WebSocket

public interface WebSocket

The WebSocket class represents websocket connections in the page.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	WebSocket.EventType
static interface	WebSocket.FrameData
static class	WebSocket.WaitForEventOptions

Method Summary

Modifier and Type	Method	Description
void	addListener(WebSocket.EventType type, Listener<WebSocket.EventType> listener)
boolean	isClosed()	Indicates that the web socket has been closed.
void	removeListener(WebSocket.EventType type, Listener<WebSocket.EventType> listener)
String	url()	Contains the URL of the WebSocket.
default Deferred<Event<WebSocket.EventType>>	waitForEvent(WebSocket.EventType event)
Deferred<Event<WebSocket.EventType>>	waitForEvent(WebSocket.EventType event, WebSocket.WaitForEventOptions options)	Returns the event data value.
default Deferred<Event<WebSocket.EventType>>	waitForEvent(WebSocket.EventType event, Predicate<Event<WebSocket.EventType>> predicate)

Method Detail

addListener

void addListener(WebSocket.EventType type,
                 Listener<WebSocket.EventType> listener)

removeListener

void removeListener(WebSocket.EventType type,
                    Listener<WebSocket.EventType> listener)

isClosed

boolean isClosed()

Indicates that the web socket has been closed.

url

String url()

Contains the URL of the WebSocket.

waitForEvent

default Deferred<Event<WebSocket.EventType>> waitForEvent(WebSocket.EventType event)

waitForEvent

default Deferred<Event<WebSocket.EventType>> waitForEvent(WebSocket.EventType event,
                                                          Predicate<Event<WebSocket.EventType>> predicate)

waitForEvent

Deferred<Event<WebSocket.EventType>> waitForEvent(WebSocket.EventType event,
                                                  WebSocket.WaitForEventOptions options)

Returns the event data value.

Waits for event to fire and passes its value into the predicate function. Resolves when the predicate returns truthy

value. Will throw an error if the webSocket is closed before the event is fired.

Parameters:

event - Event name, same one would pass into webSocket.on(event).