Interface ITerminalServer

Hierarchy

IBaseTerminalServer
- ITerminalServer

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>

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

close

close(id: number): Promise<void>

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

create

create(ITerminalServerOptions: object): Promise<number>

Overrides IBaseTerminalServer.create
- Defined in packages/terminal/src/common/terminal-protocol.ts:25
Parameters
- ITerminalServerOptions: object
Returns Promise<number>

deleteCollection

deleteCollection(extensionIdentifier: string): void

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

Parameters
- extensionIdentifier: string
Returns void

getCwdURI

getCwdURI(id: number): Promise<string>

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

getDefaultShell

getDefaultShell(): Promise<string>

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

getProcessId

getProcessId(id: number): Promise<number>

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

getProcessInfo

getProcessInfo(id: number): Promise<TerminalProcessInfo>

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

onAttachAttempted

onAttachAttempted(id: number): Promise<void>

Inherited from IBaseTerminalServer.onAttachAttempted
- 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>

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

setCollection

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

Inherited from IBaseTerminalServer.setCollection
- 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