@rocket.chat/apps-engine/server/bridges/CommandBridge.d.ts

The engine code for the Rocket.Chat Apps which manages, runs, translates, coordinates and all of that.

import type { ISlashCommand } from '../../definition/slashcommands';
import { BaseBridge } from './BaseBridge';
export declare abstract class CommandBridge extends BaseBridge {
    doDoesCommandExist(command: string, appId: string): Promise<boolean>;
    doEnableCommand(command: string, appId: string): Promise<void>;
    doDisableCommand(command: string, appId: string): Promise<void>;
    doModifyCommand(command: ISlashCommand, appId: string): Promise<void>;
    doRegisterCommand(command: ISlashCommand, appId: string): Promise<void>;
    doUnregisterCommand(command: string, appId: string): Promise<void>;
    /**
     * Checks if the provided command already exists inside of the
     * system which is being bridged. This does not check if the app
     * registered it but it will return whether the supplied command is
     * already defined by something else or not.
     *
     * @param command the command to check if it exists
     * @param appId the id of the app calling this
     * @returns whether the command is already in the system
     */
    protected abstract doesCommandExist(command: string, appId: string): Promise<boolean>;
    /**
     * Enables an existing command from the bridged system. The callee
     * must ensure that the command that's being enabled is defined by
     * the bridged system and not another App since the bridged system
     * will not check that.
     *
     * @param command the command to enable
     * @param appId the id of the app calling this
     */
    protected abstract enableCommand(command: string, appId: string): Promise<void>;
    /**
     * Disables an existing command from the bridged system, the callee must
     * ensure the command disabling is defined by the system and not another
     * App since the bridged system won't check that.
     *
     * @param command the command which to disable
     * @param appId the id of the app calling this
     */
    protected abstract disableCommand(command: string, appId: string): Promise<void>;
    /**
     * Changes how a system slash command behaves, allows Apps to provide
     * different executors per system commands.
     *
     * @param command the modified slash command
     * @param appId the id of the app calling this
     */
    protected abstract modifyCommand(command: ISlashCommand, appId: string): Promise<void>;
    /**
     * Registers a command with the system which is being bridged.
     *
     * @param command the command to register
     * @param appId the id of the app calling this
     * @param toRun the executor which is called when the command is ran
     */
    protected abstract registerCommand(command: ISlashCommand, appId: string): Promise<void>;
    /**
     * Unregisters the provided command from the bridged system.
     *
     * @param command the command to unregister
     * @param appId the id of the app calling this
     */
    protected abstract unregisterCommand(command: string, appId: string): Promise<void>;
    private hasDefaultPermission;
}