@mdf.js/openc2/dist/serviceBus/Events.d.ts

MMS - API - Observability

/**
 * Copyright 2024 Mytra Control S.L. All rights reserved.
 *
 * Use of this source code is governed by an MIT-style license that can be found in the LICENSE file
 * or at https://opensource.org/licenses/MIT.
 */
export declare class Events {
    /**
     * Check if the event is the general command event
     * @param event - event to be checked
     * @param separator - event separator
     * @returns
     */
    static isGeneralCommandEvent(event: string, separator?: string): boolean;
    /**
     * Check if the event is the general response event
     * @param event - event to be checked
     * @param separator - event separator
     * @returns
     */
    static isGeneralResponseEvent(event: string, separator?: string): boolean;
    /**
     * Check if the event is for an actuator profile command event
     * @param event - event to be checked
     * @param separator - event separator
     * @returns
     */
    static isActuatorCommandEvent(event: string, separator?: string): boolean;
    /**
     * Return the event for an concrete actuator profile
     * @param event - event to be processed
     * @param separator - event separator
     * @returns
     */
    static getActuatorFromCommandEvent(event: string, separator?: string): string;
    /**
     * Check if the event is for a concrete device
     * @param event - event to be checked
     * @param separator - event separator
     * @returns
     */
    static isDeviceCommandEvent(event: string, separator?: string): boolean;
    /**
     * Return the event for a concrete device
     * @param event - event to be processed
     * @param separator - event separator
     * @returns
     */
    static getDeviceFromCommandEvent(event: string, separator?: string): string;
    /**
     * Check if the event is for a concrete producer
     * @param event - event to be checked
     * @param separator - event separator
     * @returns
     */
    static isProducerResponseEvent(event: string, separator?: string): boolean;
    /**
     * Return the event for a concrete producer
     * @param event - event to be processed
     * @param separator - event separator
     * @returns
     */
    static getProducerFromResponseEvent(event: string, separator?: string): string;
}
//# sourceMappingURL=Events.d.ts.map