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

    Service to access the list of known Agents.

    interface AgentService {
        onDidChangeAgents: Event<void>;
        disableAgent(agentId: string): void;
        enableAgent(agentId: string): void;
        getAgents(): Agent[];
        getAllAgents(): Agent[];
        isEnabled(agentId: string): boolean;
        registerAgent(agent: Agent): void;
        unregisterAgent(agentId: string): void;
    }

    Implemented by

    Index

    Properties

    onDidChangeAgents: Event<void>

    Emitted when the list of agents changes. This can be used to update the UI when agents are added or removed.

    Methods

    • query whether this agent is currently enabled or disabled.

      Parameters

      • agentId: string

        the agent id.

      Returns boolean

      true if the agent is enabled, false otherwise.

    • Allows to unregister an agent programmatically.

      Parameters

      • agentId: string

        the agent id to unregister

      Returns void