UNPKG

1.25 kBTypeScriptView Raw
1import { Parameters } from './Parameters';
2/**
3 * Helper class that notifies components.
4 *
5 * [[INotifiable]]
6 */
7export declare class Notifier {
8 /**
9 * Notifies specific component.
10 *
11 * To be notiied components must implement [[INotifiable]] interface.
12 * If they don't the call to this method has no effect.
13 *
14 * @param correlationId (optional) transaction id to trace execution through call chain.
15 * @param component the component that is to be notified.
16 * @param args notifiation arguments.
17 *
18 * @see [[INotifiable]]
19 */
20 static notifyOne(correlationId: string, component: any, args: Parameters): void;
21 /**
22 * Notifies multiple components.
23 *
24 * To be notified components must implement [[INotifiable]] interface.
25 * If they don't the call to this method has no effect.
26 *
27 * @param correlationId (optional) transaction id to trace execution through call chain.
28 * @param components a list of components that are to be notified.
29 * @param args notification arguments.
30 *
31 * @see [[notifyOne]]
32 * @see [[INotifiable]]
33 */
34 static notify(correlationId: string, components: any[], args: Parameters): void;
35}