Class TerminalServiceMainImpl

Plugin api service allows working with terminal emulator.

Implements

TerminalServiceMain
TerminalLinkProvider
Disposable

Constructors

constructor

new TerminalServiceMainImpl(rpc, container): TerminalServiceMainImpl
Parameters
- rpc: RPCProtocol
- container: Container
Returns TerminalServiceMainImpl
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:60

Properties

`Private` `Readonly` extProxy

extProxy: TerminalServiceExt

`Private` `Readonly` hostedPluginSupport

hostedPluginSupport: HostedPluginSupport

`Private` `Readonly` observers

observers: Map<string, TerminalObserverData> = ...

`Private` `Readonly` pluginTerminalRegistry

pluginTerminalRegistry: PluginTerminalRegistry

`Private` `Readonly` sharedStyle

sharedStyle: PluginSharedStyle

`Private` `Readonly` shell

shell: ApplicationShell

`Private` `Readonly` shellTerminalServer

shellTerminalServer: ShellTerminalServerProxy

`Private` `Readonly` terminalLinkProviders

terminalLinkProviders: string[] = []

`Private` `Readonly` terminalProfileService

terminalProfileService: TerminalProfileService

`Private` `Readonly` terminals

terminals: TerminalService

`Private` `Readonly` toDispose

toDispose: DisposableCollection = ...

Methods

$createTerminal

$createTerminal(id, options, parentId?, isPseudoTerminal?): Promise<string>
Create new Terminal with Terminal options.
Parameters
- id: string
- options: TerminalOptions
  object with parameters to create new terminal.
- Optional parentId: string
- Optional isPseudoTerminal: boolean
Returns Promise<string>
Implementation of TerminalServiceMain.$createTerminal
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:155

$dispose

$dispose(id): void
Destroy terminal.
Parameters
- id: string
  terminal widget id.
Returns void
Implementation of TerminalServiceMain.$dispose
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:229

$disposeByTerminalId

$disposeByTerminalId(id, waitOnExit?): void
Destroy terminal.
Parameters
- id: number
  terminal id.
- Optional waitOnExit: string | boolean
  Whether to wait for a key press before closing the terminal.
Returns void
Implementation of TerminalServiceMain.$disposeByTerminalId
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:283

$hide

$hide(id): void
Hide UI panel where is located terminal widget.
Parameters
- id: string
  terminal widget id.
Returns void
Implementation of TerminalServiceMain.$hide
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:219

$hideByTerminalId

$hideByTerminalId(id): void
Hide UI panel where is located terminal widget.
Parameters
- id: number
  terminal id.
Returns void
Implementation of TerminalServiceMain.$hideByTerminalId
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:274

$registerTerminalLinkProvider

$registerTerminalLinkProvider(providerId): Promise<void>
Register a new terminal link provider.
Parameters
- providerId: string
  id of the terminal link provider to be registered.
Returns Promise<void>
Implementation of TerminalServiceMain.$registerTerminalLinkProvider
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:298

$registerTerminalObserver

$registerTerminalObserver(id, nrOfLinesToMatch, outputMatcherRegex): void
Register a new terminal observer.
Parameters
- id: string
- nrOfLinesToMatch: number
  the number of lines to match the outputMatcherRegex against
- outputMatcherRegex: string
  the regex to match the output to
Returns void
Implementation of TerminalServiceMain.$registerTerminalObserver
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:309

$resize

$resize(id, cols, rows): void
Resize the terminal by id.
Parameters
- id: string
  terminal widget id.
- cols: number
  columns.
- rows: number
  rows.
Returns void
Implementation of TerminalServiceMain.$resize
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:147

$resizeByTerminalId

$resizeByTerminalId(id, cols, rows): void
Resize the terminal by id.
Parameters
- id: number
  terminal id.
- cols: number
  columns.
- rows: number
  rows.
Returns void
Implementation of TerminalServiceMain.$resizeByTerminalId
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:257

$sendText

$sendText(id, text, shouldExecute?): void
Send text to the terminal by id.
Parameters
- id: string
  terminal widget id.
- text: string
  text content.
- Optional shouldExecute: boolean
  in case true - Indicates that the text being sent should be executed rather than just inserted in the terminal.
Returns void
Implementation of TerminalServiceMain.$sendText
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:197

$sendTextByTerminalId

$sendTextByTerminalId(id, text, addNewLine?): void
Send text to the terminal by id.
Parameters
- id: number
  terminal id.
- text: string
  text content.
- Optional addNewLine: boolean
  in case true - add new line after the text, otherwise - don't apply new line.
Returns void
Implementation of TerminalServiceMain.$sendTextByTerminalId
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:240

$setEnvironmentVariableCollection

$setEnvironmentVariableCollection(persistent, extensionIdentifier, rootUri, collection): void
Parameters
- persistent: boolean
- extensionIdentifier: string
- rootUri: string
- collection: SerializableEnvironmentVariableCollection
Returns void
Implementation of TerminalServiceMain.$setEnvironmentVariableCollection
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:92

$setName

$setName(id, name): void
Set the terminal widget name.
Parameters
- id: string
  terminal widget id.
- name: string
  new terminal widget name.
Returns void
Implementation of TerminalServiceMain.$setName
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:236

$setNameByTerminalId

$setNameByTerminalId(id, name): void
Set the terminal widget name.
Parameters
- id: number
  terminal id.
- name: string
  new terminal widget name.
Returns void
Implementation of TerminalServiceMain.$setNameByTerminalId
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:294

$show

$show(id, preserveFocus?): void
Show terminal on the UI panel.
Parameters
- id: string
  terminal widget id.
- Optional preserveFocus: boolean
  set terminal focus in case true value, and don't set focus otherwise.
Returns void
Implementation of TerminalServiceMain.$show
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:208

$showByTerminalId

$showByTerminalId(id, preserveFocus?): void
Show terminal on the UI panel.
Parameters
- id: number
  terminal id.
- Optional preserveFocus: boolean
  set terminal focus in case true value, and don't set focus otherwise.
Returns void
Implementation of TerminalServiceMain.$showByTerminalId
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:264

$unregisterTerminalLinkProvider

$unregisterTerminalLinkProvider(providerId): Promise<void>
Unregister the terminal link provider with the specified id.
Parameters
- providerId: string
  id of the terminal link provider to be unregistered.
Returns Promise<void>
Implementation of TerminalServiceMain.$unregisterTerminalLinkProvider
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:302

$unregisterTerminalObserver

$unregisterTerminalObserver(id): void
Unregister the terminal observer with the specified id.
Parameters
- id: string
Returns void
Implementation of TerminalServiceMain.$unregisterTerminalObserver
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:352

$write

$write(id, data): void
Write data to the terminal by id.
Parameters
- id: string
  terminal widget id.
- data: string
  data.
Returns void
Implementation of TerminalServiceMain.$write
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:139

$writeByTerminalId

$writeByTerminalId(id, data): void
Write data to the terminal by id.
Parameters
- id: number
  terminal id.
- data: string
  data.
Returns void
Implementation of TerminalServiceMain.$writeByTerminalId
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:250

dispose

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

`Protected` getTerminalLocation

getTerminalLocation(options, parentId?): undefined | TerminalLocation | TerminalEditorLocationOptions | {
parentTerminal: string;
}
Parameters
- options: TerminalOptions
- Optional parentId: string
Returns undefined | TerminalLocation | TerminalEditorLocationOptions | {
parentTerminal: string;
}
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:180

`Protected` observeTerminal

observeTerminal(observerId, terminal, observerData): void
Parameters
- observerId: string
- terminal: TerminalWidget
- observerData: TerminalObserverData
Returns void
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:321

provideLinks

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

startProfile

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

`Protected` toIconClass

toIconClass(options): undefined | string | ThemeIcon
Parameters
- options: TerminalOptions
Returns undefined | string | ThemeIcon
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:335

`Protected` trackTerminal

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

`Protected` updateCurrentTerminal

updateCurrentTerminal(): void
Returns void
- Defined in packages/plugin-ext/src/main/browser/terminal-main.ts:104

Class TerminalServiceMainImpl

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns TerminalServiceMainImpl

Properties

Private Readonly extProxy

Private Readonly hostedPluginSupport

Private Readonly observers

Private Readonly pluginTerminalRegistry

Private Readonly sharedStyle

Private Readonly shell

Private Readonly shellTerminalServer

Private Readonly terminalLinkProviders

Private Readonly terminalProfileService

Private Readonly terminals

Private Readonly toDispose

Methods

$createTerminal

Parameters

Returns Promise<string>

$dispose

Parameters

Returns void

$disposeByTerminalId

Parameters

Returns void

$hide

Parameters

Returns void

$hideByTerminalId

Parameters

Returns void

$registerTerminalLinkProvider

Parameters

Returns Promise<void>

$registerTerminalObserver

Parameters

Returns void

$resize

Parameters

Returns void

$resizeByTerminalId

Parameters

Returns void

$sendText

Parameters

Returns void

$sendTextByTerminalId

Parameters

Returns void

$setEnvironmentVariableCollection

Parameters

Returns void

$setName

Parameters

Returns void

$setNameByTerminalId

Parameters

Returns void

$show

Parameters

Returns void

$showByTerminalId

Parameters

Returns void

$unregisterTerminalLinkProvider

Parameters

Returns Promise<void>

$unregisterTerminalObserver

Parameters

Returns void

$write

Parameters

Returns void

`Private` `Readonly` extProxy

`Private` `Readonly` hostedPluginSupport

`Private` `Readonly` observers

`Private` `Readonly` pluginTerminalRegistry

`Private` `Readonly` sharedStyle

`Private` `Readonly` shell

`Private` `Readonly` shellTerminalServer

`Private` `Readonly` terminalLinkProviders

`Private` `Readonly` terminalProfileService

`Private` `Readonly` terminals

`Private` `Readonly` toDispose

`Protected` getTerminalLocation

Returns undefined | TerminalLocation | TerminalEditorLocationOptions | {
parentTerminal: string;
}

`Protected` observeTerminal

`Protected` toIconClass

`Protected` trackTerminal

`Protected` updateCurrentTerminal