Dart API Referencedart:htmlCloseEvent

CloseEvent class

A CloseEvent is sent to clients using WebSockets when the connection is closed. This is delivered to the listener indicated by the WebSocket object's onclose attribute.
@DocsEditable
@DomName('CloseEvent')
class CloseEvent extends Event native "CloseEvent" {

 @DomName('CloseEvent.code')
 @DocsEditable
 final int code;

 @DomName('CloseEvent.reason')
 @DocsEditable
 final String reason;

 @DomName('CloseEvent.wasClean')
 @DocsEditable
 final bool wasClean;
}

Extends

Interceptor > Event > CloseEvent

Properties

final bool bubbles #

inherited from Event
A boolean indicating whether the event bubbles up through the DOM or not.
final bool bubbles

final bool cancelable #

inherited from Event
A boolean indicating whether the event is cancelable.
final bool cancelable

bool cancelBubble #

inherited from Event
A boolean indicating whether the bubbling of the event has been canceled or not.
bool cancelBubble

final DataTransfer clipboardData #

inherited from Event
final DataTransfer clipboardData

final int code #

The WebSocket connection close code provided by the server. See Status codes for possible values.
final int code

final EventTarget currentTarget #

inherited from Event
EventTarget get currentTarget => _convertNativeToDart_EventTarget(this._get_currentTarget);

final bool defaultPrevented #

inherited from Event
Indicates whether or not event.preventDefault() has been called on the event.
final bool defaultPrevented

final int eventPhase #

inherited from Event
Indicates which phase of the event flow is being processed.
final int eventPhase

final int hashCode #

inherited from Interceptor

Get a hash code for this object.

All objects have hash codes. Hash codes are guaranteed to be the same for objects that are equal when compared using the equality operator ==. Other than that there are no guarantees about the hash codes. They will not be consistent between runs and there are no distribution guarantees.

If a subclass overrides hashCode it should override the equality operator as well to maintain consistency.

docs inherited from Object
int get hashCode => Primitives.objectHashCode(this);

final String reason #

A string indicating the reason the server closed the connection. This is specific to the particular server and sub-protocol.
final String reason

final Type runtimeType #

inherited from Interceptor

A representation of the runtime type of the object.

docs inherited from Object
Type get runtimeType => getRuntimeType(this);

final EventTarget target #

inherited from Event
EventTarget get target => _convertNativeToDart_EventTarget(this._get_target);

final int timeStamp #

inherited from Event
The time that the event was created.
final int timeStamp

final String type #

inherited from Event
The name of the event (case-insensitive).
final String type

final bool wasClean #

Indicates whether or not the connection was cleanly closed.
final bool wasClean

Operators

bool operator ==(other) #

inherited from Interceptor

The equality operator.

The default behavior for all Objects is to return true if and only if this and other are the same object.

If a subclass overrides the equality operator it should override the hashCode method as well to maintain consistency.

docs inherited from Object
bool operator ==(other) => identical(this, other);

Methods

dynamic noSuchMethod(Invocation invocation) #

inherited from Interceptor

noSuchMethod is invoked when users invoke a non-existant method on an object. The name of the method and the arguments of the invocation are passed to noSuchMethod in an Invocation. If noSuchMethod returns a value, that value becomes the result of the original invocation.

The default behavior of noSuchMethod is to throw a noSuchMethodError.

docs inherited from Object
dynamic noSuchMethod(Invocation invocation) {
 throw new NoSuchMethodError(
     this,
     _symbolToString(invocation.memberName),
     invocation.positionalArguments,
     _symbolMapToStringMap(invocation.namedArguments));
}

void preventDefault() #

inherited from Event
Cancels the event (if it is cancelable).
@DomName('Event.preventDefault')
@DocsEditable
void preventDefault() native;

void stopImmediatePropagation() #

inherited from Event
For this particular event, no other listener will be called. Neither those attached on the same element, nor those attached on elements which will be traversed later (in capture phase, for instance)
@DomName('Event.stopImmediatePropagation')
@DocsEditable
void stopImmediatePropagation() native;

void stopPropagation() #

inherited from Event
Stops the propagation of events further along in the DOM.
@DomName('Event.stopPropagation')
@DocsEditable
void stopPropagation() native;

String toString() #

inherited from Interceptor

Returns a string representation of this object.

docs inherited from Object
String toString() => Primitives.objectToString(this);

void $dom_initEvent(String eventTypeArg, bool canBubbleArg, bool cancelableArg) #

inherited from Event
Initializes the value of an Event created through the DocumentEvent interface.
@JSName('initEvent')
@DomName('Event.initEvent')
@DocsEditable
void $dom_initEvent(String eventTypeArg, bool canBubbleArg, bool cancelableArg) native;

This page includes content from the Mozilla Foundation that is graciously licensed under a Creative Commons: Attribution-Sharealike license. Mozilla has no other association with Dart or dartlang.org. We encourage you to improve the web by contributing to The Mozilla Developer Network.