Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Notifier

Helper class that notifies components.

INotifiable

Hierarchy

  • Notifier

Index

Methods

Methods

Static notify

  • notify(correlationId: string, components: any[], args: Parameters): void

  • Notifies multiple components.

    To be notified components must implement INotifiable interface. If they don't the call to this method has no effect.

    see

    notifyOne

    see

    INotifiable

    Parameters

    • correlationId: string

      (optional) transaction id to trace execution through call chain.

    • components: any[]

      a list of components that are to be notified.

    • args: Parameters

      notification arguments.

    Returns void

Static notifyOne

  • notifyOne(correlationId: string, component: any, args: Parameters): void

  • Notifies specific component.

    To be notiied components must implement INotifiable interface. If they don't the call to this method has no effect.

    see

    INotifiable

    Parameters

    • correlationId: string

      (optional) transaction id to trace execution through call chain.

    • component: any

      the component that is to be notified.

    • args: Parameters

      notifiation arguments.

    Returns void

Generated using TypeDoc