Event

Concrete implementation of the IEvent interface.

Implements: IEvent

Description

The Event class allows you to create events.

Important points

  • It allows you to send asynchronous notifications to multiple subscribed listeners.

Constructors

Creates a new event and assigns its name.
Throws an Error if the name is null.

public constructor(name: string)

  • name: string - the name of the event that is to be created.

Instance methods

addListener

Adds a listener to receive notifications when this event is fired.

public addListener(listener: IEventListener): void

getListeners

Gets all listeners registred in this event.

public getListeners(): IEventListener[]

getName

Gets the name of the event.

public getName(): string

  • returns: string - the name of this event.

notify

Fires this event and notifies all registred listeners.
Throws an InvocationException if the event fails to be raised.

publicnotify(correlationId: string, args: Parameters): void

  • correlationId: string - (optional) transaction id to trace execution through call chain.
  • args: Parameters - the parameters to raise this event with.

removeListener

Removes a listener, so that it no longer receives notifications for this event.

public removeListener(listener: IEventListener): void

Example:

let event = new Event("my_event");
 
event.addListener(myListener);
 *     
event.notify("123", Parameters.fromTuples(
  "param1", "ABC",
  "param2", 123
));

See also