Class TerminalServiceMainImpl

Plugin api service allows working with terminal emulator.

Hierarchy

TerminalServiceMainImpl

Implements

TerminalServiceMain
TerminalLinkProvider
Disposable

Constructors

constructor

new TerminalServiceMainImpl(rpc: RPCProtocol, container: Container): TerminalServiceMainImpl

- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:49
Parameters
- rpc: RPCProtocol
- container: Container
Returns TerminalServiceMainImpl

Properties

Private Readonly extProxy

extProxy: TerminalServiceExt

Private Readonly hostedPluginSupport

hostedPluginSupport: HostedPluginSupport

Private Readonly pluginTerminalRegistry

pluginTerminalRegistry: PluginTerminalRegistry

Private Readonly shell

shell: ApplicationShell

Private Readonly shellTerminalServer

shellTerminalServer: ShellTerminalServerProxy

Private Readonly terminalLinkProviders

terminalLinkProviders: string[] = []

Private Readonly terminals

terminals: TerminalService

Private Readonly toDispose

toDispose: DisposableCollection = ...

Methods

$createTerminal

$createTerminal(id: string, options: TerminalOptions, parentId?: string, isPseudoTerminal?: boolean): Promise<string>

Implementation of TerminalServiceMain.$createTerminal
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:139
Create new Terminal with Terminal options.

Parameters
- id: string
- options: TerminalOptions
- Optional parentId: string
- Optional isPseudoTerminal: boolean
Returns Promise<string>

$dispose

$dispose(id: string): void

Implementation of TerminalServiceMain.$dispose
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:213
Destroy terminal.

Parameters
- id: string
Returns void

$disposeByTerminalId

$disposeByTerminalId(id: number, waitOnExit?: string | boolean): void

Implementation of TerminalServiceMain.$disposeByTerminalId
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:267
Destroy terminal.

Parameters
- id: number
- Optional waitOnExit: string | boolean
Returns void

$hide

$hide(id: string): void

Implementation of TerminalServiceMain.$hide
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:203
Hide UI panel where is located terminal widget.

Parameters
- id: string
Returns void

$hideByTerminalId

$hideByTerminalId(id: number): void

Implementation of TerminalServiceMain.$hideByTerminalId
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:258
Hide UI panel where is located terminal widget.

Parameters
- id: number
Returns void

$registerTerminalLinkProvider

$registerTerminalLinkProvider(providerId: string): Promise<void>

Implementation of TerminalServiceMain.$registerTerminalLinkProvider
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:282
Register a new terminal link provider.

Parameters
- providerId: string
Returns Promise<void>

$resize

$resize(id: string, cols: number, rows: number): void

Implementation of TerminalServiceMain.$resize
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:131
Resize the terminal by id.

Parameters
- id: string
- cols: number
- rows: number
Returns void

$resizeByTerminalId

$resizeByTerminalId(id: number, cols: number, rows: number): void

Implementation of TerminalServiceMain.$resizeByTerminalId
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:241
Resize the terminal by id.

Parameters
- id: number
- cols: number
- rows: number
Returns void

$sendText

$sendText(id: string, text: string, addNewLine?: boolean): void

Implementation of TerminalServiceMain.$sendText
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:181
Send text to the terminal by id.

Parameters
- id: string
- text: string
- Optional addNewLine: boolean
Returns void

$sendTextByTerminalId

$sendTextByTerminalId(id: number, text: string, addNewLine?: boolean): void

Implementation of TerminalServiceMain.$sendTextByTerminalId
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:224
Send text to the terminal by id.

Parameters
- id: number
- text: string
- Optional addNewLine: boolean
Returns void

$setEnvironmentVariableCollection

$setEnvironmentVariableCollection(extensionIdentifier: string, persistent: boolean, collection: undefined | SerializableEnvironmentVariableCollection): void

Implementation of TerminalServiceMain.$setEnvironmentVariableCollection
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:78
Parameters
- extensionIdentifier: string
- persistent: boolean
- collection: undefined | SerializableEnvironmentVariableCollection
Returns void

$setName

$setName(id: string, name: string): void

Implementation of TerminalServiceMain.$setName
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:220
Set the terminal widget name.

Parameters
- id: string
- name: string
Returns void

$setNameByTerminalId

$setNameByTerminalId(id: number, name: string): void

Implementation of TerminalServiceMain.$setNameByTerminalId
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:278
Set the terminal widget name.

Parameters
- id: number
- name: string
Returns void

$show

$show(id: string, preserveFocus?: boolean): void

Implementation of TerminalServiceMain.$show
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:192
Show terminal on the UI panel.

Parameters
- id: string
- Optional preserveFocus: boolean
Returns void

$showByTerminalId

$showByTerminalId(id: number, preserveFocus?: boolean): void

Implementation of TerminalServiceMain.$showByTerminalId
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:248
Show terminal on the UI panel.

Parameters
- id: number
- Optional preserveFocus: boolean
Returns void

$unregisterTerminalLinkProvider

$unregisterTerminalLinkProvider(providerId: string): Promise<void>

Implementation of TerminalServiceMain.$unregisterTerminalLinkProvider
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:286
Unregister the terminal link provider with the specified id.

Parameters
- providerId: string
Returns Promise<void>

$write

$write(id: string, data: string): void

Implementation of TerminalServiceMain.$write
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:123
Write data to the terminal by id.

Parameters
- id: string
- data: string
Returns void

$writeByTerminalId

$writeByTerminalId(id: number, data: string): void

Implementation of TerminalServiceMain.$writeByTerminalId
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:234
Write data to the terminal by id.

Parameters
- id: number
- data: string
Returns void

dispose

dispose(): void

Implementation of Disposable.dispose
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:86
Returns void

Protected getTerminalLocation

getTerminalLocation(options: TerminalOptions, parentId?: string): undefined | TerminalLocation | TerminalEditorLocationOptions | { parentTerminal: string }

- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:164
Parameters
- options: TerminalOptions
- Optional parentId: string
Returns undefined | TerminalLocation | TerminalEditorLocationOptions | { parentTerminal: string }

provideLinks

provideLinks(line: string, terminal: TerminalWidget, cancellationToken?: CancellationToken): Promise<TerminalLink[]>

Implementation of TerminalLinkProvider.provideLinks
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:293
Parameters
- line: string
- terminal: TerminalWidget
- Optional cancellationToken: CancellationToken
Returns Promise<TerminalLink[]>

startProfile

startProfile(id: string): Promise<string>

- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:73
Parameters
- id: string
Returns Promise<string>

Protected trackTerminal

trackTerminal(terminal: TerminalWidget): Promise<void>

- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:95
Parameters
- terminal: TerminalWidget
Returns Promise<void>

Protected updateCurrentTerminal

updateCurrentTerminal(): void

- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:90
Returns void