Interface IBaseTerminalServer

Hierarchy

JsonRpcServer<IBaseTerminalClient>
- IBaseTerminalServer
  - IShellTerminalServer
  - ITerminalServer

Implemented by

BaseTerminalServer

Index

Properties

Methods

Properties

Readonly collections

collections: ReadonlyMap<string, EnvironmentVariableCollection>

Gets a single collection constructed by merging all environment variable collections into one.

Readonly mergedCollection

mergedCollection: MergedEnvironmentVariableCollection

Gets a single collection constructed by merging all environment variable collections into one.

Methods

attach

attach(id: number): Promise<number>

- Defined in packages/terminal/src/common/base-terminal-protocol.ts:33
Parameters
- id: number
Returns Promise<number>

close

close(id: number): Promise<void>

- Defined in packages/terminal/src/common/base-terminal-protocol.ts:35
Parameters
- id: number
Returns Promise<void>

create

create(IBaseTerminalServerOptions: object): Promise<number>

- Defined in packages/terminal/src/common/base-terminal-protocol.ts:28
Parameters
- IBaseTerminalServerOptions: object
Returns Promise<number>

deleteCollection

deleteCollection(extensionIdentifier: string): void

- Defined in packages/terminal/src/common/base-terminal-protocol.ts:55
Deletes an extension's environment variable collection.

Parameters
- extensionIdentifier: string
Returns void

dispose

dispose(): void

Inherited from JsonRpcServer.dispose
- Defined in packages/core/lib/common/disposable.d.ts:21
Dispose this object.

Returns void

Optional getClient

getClient(): undefined | IBaseTerminalClient

Inherited from JsonRpcServer.getClient
- Defined in packages/core/lib/common/messaging/proxy-factory.d.ts:27
Returns undefined | IBaseTerminalClient

getCwdURI

getCwdURI(id: number): Promise<string>

- Defined in packages/terminal/src/common/base-terminal-protocol.ts:31
Parameters
- id: number
Returns Promise<string>

getDefaultShell

getDefaultShell(): Promise<string>

- Defined in packages/terminal/src/common/base-terminal-protocol.ts:36
Returns Promise<string>

getProcessId

getProcessId(id: number): Promise<number>

- Defined in packages/terminal/src/common/base-terminal-protocol.ts:29
Parameters
- id: number
Returns Promise<number>

getProcessInfo

getProcessInfo(id: number): Promise<TerminalProcessInfo>

- Defined in packages/terminal/src/common/base-terminal-protocol.ts:30
Parameters
- id: number
Returns Promise<TerminalProcessInfo>

onAttachAttempted

onAttachAttempted(id: number): Promise<void>

- Defined in packages/terminal/src/common/base-terminal-protocol.ts:34
Parameters
- id: number
Returns Promise<void>

resize

resize(id: number, cols: number, rows: number): Promise<void>

- Defined in packages/terminal/src/common/base-terminal-protocol.ts:32
Parameters
- id: number
- cols: number
- rows: number
Returns Promise<void>

setClient

setClient(client: undefined | IBaseTerminalClient): void

Inherited from JsonRpcServer.setClient
- Defined in packages/core/lib/common/messaging/proxy-factory.d.ts:26
If this server is a proxy to a remote server then a client is used as a local object to handle JSON-RPC messages from the remote server.

Parameters
- client: undefined | IBaseTerminalClient
Returns void

setCollection

setCollection(extensionIdentifier: string, persistent: boolean, collection: SerializableEnvironmentVariableCollection): void

- Defined in packages/terminal/src/common/base-terminal-protocol.ts:51
Sets an extension's environment variable collection.

Parameters
- extensionIdentifier: string
- persistent: boolean
- collection: SerializableEnvironmentVariableCollection
Returns void