Methods
-
clear()
-
Deregisters all event listeners currently registered with this dispatcher.
Returns:
This dispatcher.
- Type
- Dispatcher
-
fire(event, data [, imaInternalEvent])
-
Fires a new event of the specified name, carrying the provided data.
The method will synchronously execute all event listeners registered for the specified event, passing the provided data to them as the first argument.
Note that this method does not prevent the event listeners to modify the data in any way. The order in which the event listeners will be executed is unspecified and should not be relied upon.
Parameters:
Name Type Argument Default Description event
string The name of the event to fire.
data
Object.<string, *> The data to pass to the event listeners.
imaInternalEvent
boolean <optional>
false The flag signalling whether this is an internal IMA event. The fired event is treated as a custom application event if this flag is not set. The flag is used only for debugging and has no effect on the propagation of the event.
Returns:
This dispatcher.
- Type
- Dispatcher
-
listen(event, listener [, scope])
-
Registers the provided event listener to be executed when the specified event is fired on this dispatcher.
When the specified event is fired, the event listener will be executed with the data passed with the event as the first argument.
The order in which the event listeners will be executed is unspecified and should not be relied upon. Registering the same listener for the same event and with the same scope multiple times has no effect.
Parameters:
Name Type Argument Default Description event
string The name of the event to listen for.
listener
function The event listener to register.
scope
Object <optional>
<nullable>
null The object to which the
this
keyword will be bound in the event listener.Returns:
This dispatcher.
- Type
- Dispatcher
-
unlisten(event, listener [, scope])
-
Deregisters the provided event listener, so it will no longer be executed with the specified scope when the specified event is fired.
Parameters:
Name Type Argument Default Description event
string The name of the event for which the listener should be deregistered.
listener
function The event listener to deregister.
scope
Object <optional>
<nullable>
null The object to which the
this
keyword would be bound in the event listener.Returns:
This dispatcher.
- Type
- Dispatcher