Interface TerminalServiceMain

Hierarchy

TerminalServiceMain

Implemented by

TerminalServiceMainImpl

Index

Methods

Methods

$createTerminal

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

- Defined in packages/plugin-ext/src/common/plugin-api-rpc.ts:312
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>

$dispose

$dispose(id: string): void

- Defined in packages/plugin-ext/src/common/plugin-api-rpc.ts:354
Destroy terminal.

Parameters
- id: string
  
  terminal widget id.
Returns void

$disposeByTerminalId

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

- Defined in packages/plugin-ext/src/common/plugin-api-rpc.ts:404
Destroy terminal.

Parameters
- id: number
  
  terminal id.
- Optional waitOnExit: string | boolean
  
  Whether to wait for a key press before closing the terminal.
Returns void

$hide

$hide(id: string): void

- Defined in packages/plugin-ext/src/common/plugin-api-rpc.ts:348
Hide UI panel where is located terminal widget.

Parameters
- id: string
  
  terminal widget id.
Returns void

$hideByTerminalId

$hideByTerminalId(id: number): void

- Defined in packages/plugin-ext/src/common/plugin-api-rpc.ts:397
Hide UI panel where is located terminal widget.

Parameters
- id: number
  
  terminal id.
Returns void

$registerTerminalLinkProvider

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

- Defined in packages/plugin-ext/src/common/plugin-api-rpc.ts:419
Register a new terminal link provider.

Parameters
- providerId: string
  
  id of the terminal link provider to be registered.
Returns Promise<void>

$resize

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

- Defined in packages/plugin-ext/src/common/plugin-api-rpc.ts:335
Resize the terminal by id.

Parameters
- id: string
  
  terminal widget id.
- cols: number
  
  columns.
- rows: number
  
  rows.
Returns void

$resizeByTerminalId

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

- Defined in packages/plugin-ext/src/common/plugin-api-rpc.ts:384
Resize the terminal by id.

Parameters
- id: number
  
  terminal id.
- cols: number
  
  columns.
- rows: number
  
  rows.
Returns void

$sendText

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

- Defined in packages/plugin-ext/src/common/plugin-api-rpc.ts:320
Send text to the terminal by id.

Parameters
- id: string
  
  terminal widget 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

$sendTextByTerminalId

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

- Defined in packages/plugin-ext/src/common/plugin-api-rpc.ts:369
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

$setEnvironmentVariableCollection

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

- Defined in packages/plugin-ext/src/common/plugin-api-rpc.ts:406
Parameters
- extensionIdentifier: string
- persistent: boolean
- collection: undefined | SerializableEnvironmentVariableCollection
Returns void

$setName

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

- Defined in packages/plugin-ext/src/common/plugin-api-rpc.ts:361
Set the terminal widget name.

Parameters
- id: string
  
  terminal widget id.
- name: string
  
  new terminal widget name.
Returns void

$setNameByTerminalId

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

- Defined in packages/plugin-ext/src/common/plugin-api-rpc.ts:413
Set the terminal widget name.

Parameters
- id: number
  
  terminal id.
- name: string
  
  new terminal widget name.
Returns void

$show

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

- Defined in packages/plugin-ext/src/common/plugin-api-rpc.ts:342
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

$showByTerminalId

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

- Defined in packages/plugin-ext/src/common/plugin-api-rpc.ts:391
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

$unregisterTerminalLinkProvider

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

- Defined in packages/plugin-ext/src/common/plugin-api-rpc.ts:425
Unregister the terminal link provider with the specified id.

Parameters
- providerId: string
  
  id of the terminal link provider to be unregistered.
Returns Promise<void>

$write

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

- Defined in packages/plugin-ext/src/common/plugin-api-rpc.ts:327
Write data to the terminal by id.

Parameters
- id: string
  
  terminal widget id.
- data: string
  
  data.
Returns void

$writeByTerminalId

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

- Defined in packages/plugin-ext/src/common/plugin-api-rpc.ts:376
Write data to the terminal by id.

Parameters
- id: number
  
  terminal id.
- data: string
  
  data.
Returns void