Theia API Documentation v1.65.0
    Preparing search index...

    Interface FrontendVariableService

    interface FrontendVariableService {
        onDidChangeVariables: Event<void>;
        getArgumentCompletionProvider(
            name: string,
        ): Promise<undefined | AIVariableArgCompletionProvider>;
        getArgumentPicker(
            name: string,
            context: AIVariableContext,
        ): Promise<undefined | AIVariableArgPicker>;
        getContextVariables(): Readonly<AIContextVariable>[];
        getDropResult(
            event: DragEvent,
            context: AIVariableContext,
        ): Promise<AIVariableDropResult>;
        getOpener(
            name: string,
            arg: undefined | string,
            context: AIVariableContext,
        ): Promise<undefined | AIVariableOpener>;
        getPasteResult(
            event: ClipboardEvent,
            context: AIVariableContext,
        ): Promise<AIVariablePasteResult>;
        getResolver(
            name: string,
            arg: undefined | string,
            context: AIVariableContext,
        ): Promise<undefined | AIVariableResolver>;
        getVariable(name: string): undefined | Readonly<AIVariable>;
        getVariables(): Readonly<AIVariable>[];
        hasVariable(name: string): boolean;
        open(variable: AIVariableArg, context?: AIVariableContext): Promise<void>;
        registerArgumentCompletionProvider(
            variable: AIVariable,
            argPicker: AIVariableArgCompletionProvider,
        ): Disposable;
        registerArgumentPicker(
            variable: AIVariable,
            argPicker: AIVariableArgPicker,
        ): Disposable;
        registerDropHandler(handler: AIVariableDropHandler): Disposable;
        registerOpener(variable: AIVariable, opener: AIVariableOpener): Disposable;
        registerPasteHandler(handler: AIVariablePasteHandler): Disposable;
        registerResolver(
            variable: AIVariable,
            resolver: AIVariableResolver,
        ): Disposable;
        registerVariable(variable: AIVariable): Disposable;
        resolveVariable(
            variable: AIVariableArg,
            context: AIVariableContext,
            cache?: Map<string, ResolveAIVariableCacheEntry>,
        ): Promise<undefined | ResolvedAIVariable>;
        unregisterArgumentCompletionProvider(
            variable: AIVariable,
            argPicker: AIVariableArgCompletionProvider,
        ): void;
        unregisterArgumentPicker(
            variable: AIVariable,
            argPicker: AIVariableArgPicker,
        ): void;
        unregisterDropHandler(handler: AIVariableDropHandler): void;
        unregisterOpener(variable: AIVariable, opener: AIVariableOpener): void;
        unregisterPasteHandler(handler: AIVariablePasteHandler): void;
        unregisterResolver(
            variable: AIVariable,
            resolver: AIVariableResolver,
        ): void;
        unregisterVariable(name: string): void;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    onDidChangeVariables

    Methods

    getArgumentCompletionProvider getArgumentPicker getContextVariables getDropResult getOpener getPasteResult getResolver getVariable getVariables hasVariable open registerArgumentCompletionProvider registerArgumentPicker registerDropHandler registerOpener registerPasteHandler registerResolver registerVariable resolveVariable unregisterArgumentCompletionProvider unregisterArgumentPicker unregisterDropHandler unregisterOpener unregisterPasteHandler unregisterResolver unregisterVariable

    Properties

    onDidChangeVariables: Event<void>

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods