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

    Interface TaskServer

    interface TaskServer {
        customExecutionComplete(
            id: number,
            exitCode: undefined | number,
        ): Promise<void>;
        disconnectClient(client: TaskClient): void;
        dispose(): void;
        getClient?(): undefined | TaskClient;
        getRegisteredTaskTypes(): Promise<string[]>;
        getTasks(ctx?: string): Promise<TaskInfo[]>;
        kill(taskId: number): Promise<void>;
        run(
            task: TaskConfiguration,
            ctx?: string,
            option?: RunTaskOption,
        ): Promise<TaskInfo>;
        setClient(client: undefined | TaskClient): void;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Methods

    customExecutionComplete disconnectClient dispose getClient? getRegisteredTaskTypes getTasks kill run setClient

    Methods

    • plugin callback task complete

      Parameters

      • id: number
      • exitCode: undefined | number

      Returns Promise<void>

    • Dispose this object.

      Returns void

    • Returns undefined | TaskClient

    • Returns a list of currently running tasks. If a context is provided, only the tasks started in that context will be provided. Using an undefined context matches all tasks, no matter the creation context.

      Parameters

      • Optionalctx: string

      Returns Promise<TaskInfo[]>

    • If this server is a proxy to a remote server then a client is used as a local object to handle RPC messages from the remote server.

      Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods