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

    Interface ITerminalServer

    interface ITerminalServer {
        attach(id: number): Promise<number>;
        close(id: number): Promise<void>;
        create(ITerminalServerOptions: object): Promise<number>;
        dispose(): void;
        getClient?(): undefined | IBaseTerminalClient;
        getCwdURI(id: number): Promise<string>;
        getDefaultShell(): Promise<string>;
        getProcessId(id: number): Promise<number>;
        getProcessInfo(id: number): Promise<TerminalProcessInfo>;
        onAttachAttempted(id: number): Promise<void>;
        resize(id: number, cols: number, rows: number): Promise<void>;
        setClient(client: undefined | IBaseTerminalClient): void;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Methods

    attach close create dispose getClient? getCwdURI getDefaultShell getProcessId getProcessInfo onAttachAttempted resize setClient

    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

    Settings

    Member Visibility

    On This Page

    Methods