INotifiable

Interface that allows you to create components that can be asynchronously notified.

Description

The INotifiable interface allows you to create components that can be asynchronously notified.

Important points

  • The notification can include an optional argument that describes an occurred event.

Instance methods

notify

Notifies the component about occured event.

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

  • correlationId: string - (optional) transaction id to trace execution through call chain.
  • args: Parameters - notification arguments.

Examples

class MyComponent implements INotifable {
    ...
    public notify(correlationId: string, args: Parameters): void {
        console.log("Occured event " + args.getAsString("event"));
    }
}
   
let myComponent = new MyComponent();
    
myComponent.notify("123", Parameters.fromTuples("event", "Test Event"));

See also