Class TerminalServiceMainImpl

Plugin api service allows working with terminal emulator.

Implements

Constructors

constructor

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

Methods

$createTerminal

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

$dispose

$dispose(id: string): 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:233

$disposeByTerminalId

$disposeByTerminalId(id: number, waitOnExit?: string | boolean): void
Destroy terminal.
Parameters
- id: number
  terminal id.
- OptionalwaitOnExit: 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:287

$hide

$hide(id: string): 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:223

$hideByTerminalId

$hideByTerminalId(id: number): 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:278

$registerTerminalLinkProvider

$registerTerminalLinkProvider(providerId: string): 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:302

$registerTerminalObserver

$registerTerminalObserver(
    id: string,
    nrOfLinesToMatch: number,
    outputMatcherRegex: string,
): 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:313

$resize

$resize(id: string, cols: number, rows: number): 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:150

$resizeByTerminalId

$resizeByTerminalId(id: number, cols: number, rows: number): 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:261

$sendText

$sendText(id: string, text: string, shouldExecute?: boolean): void
Send text to the terminal by id.
Parameters
- id: string
  terminal widget id.
- text: string
  text content.
- OptionalshouldExecute: 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:201

$sendTextByTerminalId

$sendTextByTerminalId(id: number, text: string, addNewLine?: boolean): void
Send text to the terminal by id.
Parameters
- id: number
  terminal id.
- text: string
  text content.
- OptionaladdNewLine: 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:244

$setEnvironmentVariableCollection

$setEnvironmentVariableCollection(
    persistent: boolean,
    extensionIdentifier: string,
    rootUri: string,
    collection: SerializableEnvironmentVariableCollection,
): 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: string, name: string): 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:240

$setNameByTerminalId

$setNameByTerminalId(id: number, name: string): 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:298

$show

$show(id: string, preserveFocus?: boolean): void
Show terminal on the UI panel.
Parameters
- id: string
  terminal widget id.
- OptionalpreserveFocus: 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:212

$showByTerminalId

$showByTerminalId(id: number, preserveFocus?: boolean): void
Show terminal on the UI panel.
Parameters
- id: number
  terminal id.
- OptionalpreserveFocus: 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:268

$unregisterTerminalLinkProvider

$unregisterTerminalLinkProvider(providerId: string): 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:306

$unregisterTerminalObserver

$unregisterTerminalObserver(id: string): 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:356

$write

$write(id: string, data: string): 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:142

$writeByTerminalId

$writeByTerminalId(id: number, data: string): 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:254

dispose

dispose(): void
Dispose this object.

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

`Protected`getTerminalLocation

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

`Protected`observeTerminal

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

provideLinks

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

startProfile

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

`Protected`toIconClass

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

`Protected`trackTerminal

trackTerminal(terminal: TerminalWidget): 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

Methods

Constructors

constructor

Parameters

Returns TerminalServiceMainImpl

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

$writeByTerminalId

Parameters

Returns void

dispose

Returns void

ProtectedgetTerminalLocation

Parameters

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

ProtectedobserveTerminal

Parameters

Returns void

provideLinks

Parameters

`Protected`getTerminalLocation

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

`Protected`observeTerminal

`Protected`toIconClass

`Protected`trackTerminal

`Protected`updateCurrentTerminal