@finos/legend-application/lib/stores/event/EventService.d.ts

Legend application core

/**
 * Copyright (c) 2020-present, Goldman Sachs
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
import { AbstractPlugin, type AbstractPluginManager } from '@finos/legend-shared';
export interface NotificationEventData {
    [key: string]: unknown;
}
export interface EventNotifierPluginManager extends AbstractPluginManager {
    registerEventNotifierPlugin(plugin: EventNotifierPlugin): void;
    getEventNotifierPlugins(): EventNotifierPlugin[];
}
export declare abstract class EventNotifierPlugin extends AbstractPlugin {
    install(pluginManager: EventNotifierPluginManager): void;
    /**
     * NOTE: Similar to telemetry service, event notifier should be considered "fire and forget"
     * it should not throw any error
     */
    abstract notify(event: string, data: NotificationEventData): void;
}
export declare class EventService {
    private notifierPlugins;
    registerEventNotifierPlugins(plugins: EventNotifierPlugin[]): void;
    notify(event: string, data: NotificationEventData): void;
}
//# sourceMappingURL=EventService.d.ts.map