WebSocket class

The object provides the API for creating and managing a WebSocket connection to a server, as well as for sending and receiving data on the connection. To construct a , use the WebSocket() constructor. Note: This feature is available in Web Workers

EventTarget

WebSocket

Implemented types

EventTarget

Available extensions

Annotations

@JS()
@staticInterop

Constructors

WebSocket(String url, [dynamic protocols = const []]): factory

Properties

binaryType ↔ BinaryType: Available on WebSocket, provided by the PropsWebSocket extension

getter/setter pair
bufferedAmount → int: Available on WebSocket, provided by the PropsWebSocket extension

no setter
extensions → String: Available on WebSocket, provided by the PropsWebSocket extension

no setter
hashCode → int: The hash code for this object.
no setterinherited
onclose ↔ EventHandlerNonNull<Event>?: Available on WebSocket, provided by the PropsWebSocket extension

getter/setter pair
onerror ↔ EventHandlerNonNull<Event>?: Available on WebSocket, provided by the PropsWebSocket extension

getter/setter pair
onmessage ↔ EventHandlerNonNull<Event>?: Available on WebSocket, provided by the PropsWebSocket extension

getter/setter pair
onopen ↔ EventHandlerNonNull<Event>?: Available on WebSocket, provided by the PropsWebSocket extension

getter/setter pair
protocol → String: Available on WebSocket, provided by the PropsWebSocket extension

no setter
readyState → int: Available on WebSocket, provided by the PropsWebSocket extension

no setter
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
url → String: Available on WebSocket, provided by the PropsWebSocket extension

no setter

Methods

addEventListener(String type, EventListener? callback, [dynamic options]) → void: Available on EventTarget, provided by the PropsEventTarget extension
close([int? code, String? reason]) → void: Available on WebSocket, provided by the PropsWebSocket extension
dispatchEvent(Event event) → bool: Available on EventTarget, provided by the PropsEventTarget extension
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
removeEventListener(String type, EventListener? callback, [dynamic options]) → void: Available on EventTarget, provided by the PropsEventTarget extension
send(dynamic data) → void: Available on WebSocket, provided by the PropsWebSocket extension
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Properties

closed → int: no setter
closing → int: no setter
connecting → int: no setter
open → int: no setter