Theia API Documentation v1.65.0
    Preparing search index...
    interface IShellTerminalServer {
        attach(id: number): Promise<number>;
        close(id: number): Promise<void>;
        create(IBaseTerminalServerOptions: object): Promise<number>;
        deleteCollection(extensionIdentifier: string): void;
        dispose(): void;
        getClient?(): undefined | IBaseTerminalClient;
        getCwdURI(id: number): Promise<string>;
        getDefaultShell(): Promise<string>;
        getEnvVarCollectionDescriptionsByExtension(
            id: number,
        ): Promise<Map<string, (undefined | string | MarkdownString)[]>>;
        getEnvVarCollections(): Promise<
            [string, string, boolean, SerializableEnvironmentVariableCollection][],
        >;
        getProcessId(id: number): Promise<number>;
        getProcessInfo(id: number): Promise<TerminalProcessInfo>;
        hasChildProcesses(processId: undefined | number): Promise<boolean>;
        onAttachAttempted(id: number): Promise<void>;
        resize(id: number, cols: number, rows: number): Promise<void>;
        restorePersisted(jsonValue: string): void;
        setClient(client: undefined | IBaseTerminalClient): void;
        setCollection(
            extensionIdentifier: string,
            rootUri: string,
            persistent: boolean,
            collection: SerializableEnvironmentVariableCollection,
            description: undefined | string | MarkdownString,
        ): void;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Methods

    • Dispose this object.

      Returns void

    • 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