@itwin/presentation-common/lib/cjs/presentation-common/PresentationIpcInterface.d.ts

Common pieces for iModel.js presentation packages

/** @packageDocumentation
 * @module Core
 */
import { RulesetVariableJSON } from "./RulesetVariables.js";
/** @internal */
export declare const PRESENTATION_IPC_CHANNEL_NAME = "itwinjs-presentation/ipc-interface";
interface CommonIpcParams {
    clientId: string;
}
interface SetRulesetVariableParams<TVariable> extends CommonIpcParams {
    rulesetId: string;
    variable: TVariable;
}
interface UnsetRulesetVariableParams extends CommonIpcParams {
    rulesetId: string;
    variableId: string;
}
/** @internal */
export interface PresentationIpcInterface {
    /** Sets ruleset variable value. */
    setRulesetVariable(params: SetRulesetVariableParams<RulesetVariableJSON>): Promise<void>;
    /** Unsets ruleset variable value. */
    unsetRulesetVariable(params: UnsetRulesetVariableParams): Promise<void>;
}
/** @internal */
export declare enum PresentationIpcEvents {
    /**
     * ID of an event that's emitted when backend detects changes in presented data.
     */
    Update = "presentation.onUpdate"
}
export {};
//# sourceMappingURL=PresentationIpcInterface.d.ts.map