Class: SignalEvent

The Session object dispatches a signal event when the client receives a signal from the session.

Properties

Name Type Description
type String The type assigned to the signal (if there is one). Use the type to filter signals received (by adding an event handler for signal:type1 or signal:type2, etc.)
data String The data string sent with the signal (if there is one).
from Connection The Connection corresponding to the client that sent the signal.
See:

Methods

Name Description
isDefaultPrevented() → {Boolean} Whether the default event behavior has been prevented via a call to preventDefault() (true) or not (false).
preventDefault() Prevents the default behavior associated with the event from taking place.

isDefaultPrevented() → {Boolean}

Whether the default event behavior has been prevented via a call to preventDefault() (true) or not (false). See preventDefault().
Returns:

preventDefault()

Prevents the default behavior associated with the event from taking place.

To see whether an event has a default behavior, check the cancelable property of the event object.

Call the preventDefault() method in the callback function for the event.

The following events have default behaviors: