Class TerminalServiceExtImpl

Provides high level terminal plugin api to use in the Theia plugins. This service allow(with help proxy) create and use terminal emulator.

Implements

TerminalServiceExt

Constructors

constructor

new TerminalServiceExtImpl(rpc: RPCProtocol): TerminalServiceExtImpl
Parameters
- rpc: RPCProtocol
Returns TerminalServiceExtImpl
- Defined in packages/plugin-ext/src/plugin/terminal-ext.ts:65

Properties

`Protected`environmentVariableCollections

environmentVariableCollections: MultiKeyMap<
string,
EnvironmentVariableCollectionImpl,
> = ...

`Readonly`onDidChangeActiveTerminal

onDidChangeActiveTerminal: Event<undefined | Terminal> = ...

`Readonly`onDidChangeShell

onDidChangeShell: Event<string> = ...

`Readonly`onDidChangeTerminalState

onDidChangeTerminalState: Event<Terminal> = ...

`Readonly`onDidCloseTerminal

onDidCloseTerminal: Event<Terminal> = ...

`Readonly`onDidOpenTerminal

onDidOpenTerminal: Event<Terminal> = ...

Accessors

activeTerminal

get activeTerminal(): undefined | TerminalExtImpl
Returns undefined | TerminalExtImpl
- Defined in packages/plugin-ext/src/plugin/terminal-ext.ts:248

defaultShell

get defaultShell(): string
Returns string
- Defined in packages/plugin-ext/src/plugin/terminal-ext.ts:73

terminals

get terminals(): TerminalExtImpl[]
Returns TerminalExtImpl[]
- Defined in packages/plugin-ext/src/plugin/terminal-ext.ts:69

Methods

$currentTerminalChanged

$currentTerminalChanged(id: undefined | string): void
Parameters
- id: undefined | string
Returns void
Implementation of TerminalServiceExt.$currentTerminalChanged
- Defined in packages/plugin-ext/src/plugin/terminal-ext.ts:251

$handleTerminalLink

$handleTerminalLink(link: ProvidedTerminalLink): Promise<void>
Parameters
- link: ProvidedTerminalLink
Returns Promise<void>
Implementation of TerminalServiceExt.$handleTerminalLink
- Defined in packages/plugin-ext/src/plugin/terminal-ext.ts:334

$initEnvironmentVariableCollections

$initEnvironmentVariableCollections(
    collections: [
        string,
        string,
        boolean,
        SerializableEnvironmentVariableCollection,
    ][],
): void
Parameters
- collections: [string, string, boolean, SerializableEnvironmentVariableCollection][]
Returns void
Implementation of TerminalServiceExt.$initEnvironmentVariableCollections
- Defined in packages/plugin-ext/src/plugin/terminal-ext.ts:383

$provideTerminalLinks

$provideTerminalLinks(
    line: string,
    terminalId: string,
    token: CancellationToken,
): Promise<ProvidedTerminalLink[]>
Parameters
- line: string
- terminalId: string
- token: CancellationToken
Returns Promise<ProvidedTerminalLink[]>
Implementation of TerminalServiceExt.$provideTerminalLinks
- Defined in packages/plugin-ext/src/plugin/terminal-ext.ts:320

$reportOutputMatch

$reportOutputMatch(observerId: string, groups: string[]): void
Parameters
- observerId: string
- groups: string[]
Returns void
Implementation of TerminalServiceExt.$reportOutputMatch
- Defined in packages/plugin-ext/src/plugin/terminal-ext.ts:288

$setShell

$setShell(shell: string): Promise<void>
Parameters
- shell: string
Returns Promise<void>
Implementation of TerminalServiceExt.$setShell
- Defined in packages/plugin-ext/src/plugin/terminal-ext.ts:77

$startProfile

$startProfile(
profileId: string,
cancellationToken: CancellationToken,
): Promise<string>
Parameters
- profileId: string
- cancellationToken: CancellationToken
Returns Promise<string>
Implementation of TerminalServiceExt.$startProfile
- Defined in packages/plugin-ext/src/plugin/terminal-ext.ts:301

$terminalClosed

$terminalClosed(id: string, exitStatus: undefined | TerminalExitStatus): void
Parameters
- id: string
- exitStatus: undefined | TerminalExitStatus
Returns void
Implementation of TerminalServiceExt.$terminalClosed
- Defined in packages/plugin-ext/src/plugin/terminal-ext.ts:233

$terminalCreated

$terminalCreated(id: string, name: string): void
Parameters
- id: string
- name: string
Returns void
Implementation of TerminalServiceExt.$terminalCreated
- Defined in packages/plugin-ext/src/plugin/terminal-ext.ts:194

$terminalNameChanged

$terminalNameChanged(id: string, name: string): void
Parameters
- id: string
- name: string
Returns void
Implementation of TerminalServiceExt.$terminalNameChanged
- Defined in packages/plugin-ext/src/plugin/terminal-ext.ts:200

$terminalOnInput

$terminalOnInput(id: string, data: string): void
Parameters
- id: string
- data: string
Returns void
Implementation of TerminalServiceExt.$terminalOnInput
- Defined in packages/plugin-ext/src/plugin/terminal-ext.ts:156

$terminalOnInteraction

$terminalOnInteraction(id: string): void
Parameters
- id: string
Returns void
Implementation of TerminalServiceExt.$terminalOnInteraction
- Defined in packages/plugin-ext/src/plugin/terminal-ext.ts:164

$terminalOpened

$terminalOpened(
    id: string,
    processId: number,
    terminalId: number,
    cols: number,
    rows: number,
): void
Parameters
- id: string
- processId: number
- terminalId: number
- cols: number
- rows: number
Returns void
Implementation of TerminalServiceExt.$terminalOpened
- Defined in packages/plugin-ext/src/plugin/terminal-ext.ts:207

$terminalShellTypeChanged

$terminalShellTypeChanged(id: string, shellType: string): void
Parameters
- id: string
- shellType: string
Returns void
Implementation of TerminalServiceExt.$terminalShellTypeChanged
- Defined in packages/plugin-ext/src/plugin/terminal-ext.ts:175

$terminalSizeChanged

$terminalSizeChanged(id: string, clos: number, rows: number): void
Parameters
- id: string
- clos: number
- rows: number
Returns void
Implementation of TerminalServiceExt.$terminalSizeChanged
- Defined in packages/plugin-ext/src/plugin/terminal-ext.ts:186

attachPtyToTerminal

attachPtyToTerminal(terminalId: number, pty: Pseudoterminal): void
Parameters
- terminalId: number
- pty: Pseudoterminal
Returns void
- Defined in packages/plugin-ext/src/plugin/terminal-ext.ts:142

createTerminal

createTerminal(
    plugin: Plugin,
    nameOrOptions:
        | undefined
        | string
        | TerminalOptions
        | PseudoTerminalOptions
        | ExtensionTerminalOptions,
    shellPath?: string,
    shellArgs?: string | string[],
): Terminal
Parameters
- plugin: Plugin
- nameOrOptions:
      | undefined
      | string
      | TerminalOptions
      | PseudoTerminalOptions
      | ExtensionTerminalOptions
- OptionalshellPath: string
- OptionalshellArgs: string | string[]
Returns Terminal
- Defined in packages/plugin-ext/src/plugin/terminal-ext.ts:84

registerTerminalQuickFixProvider

registerTerminalQuickFixProvider(
id: string,
provider: TerminalQuickFixProvider,
): Disposable
Parameters
- id: string
- provider: TerminalQuickFixProvider
Returns Disposable
Stubbed
- Defined in packages/plugin-ext/src/plugin/terminal-ext.ts:274

Class TerminalServiceExtImpl

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns TerminalServiceExtImpl

Properties

ProtectedenvironmentVariableCollections

ReadonlyonDidChangeActiveTerminal

ReadonlyonDidChangeShell

ReadonlyonDidChangeTerminalState

ReadonlyonDidCloseTerminal

ReadonlyonDidOpenTerminal

Accessors

activeTerminal

Returns undefined | TerminalExtImpl

defaultShell

Returns string

terminals

Returns TerminalExtImpl[]

Methods

$currentTerminalChanged

Parameters

Returns void

$handleTerminalLink

Parameters

Returns Promise<void>

$initEnvironmentVariableCollections

Parameters

Returns void

$provideTerminalLinks

Parameters

Returns Promise<ProvidedTerminalLink[]>

$reportOutputMatch

Parameters

Returns void

$setShell

Parameters

Returns Promise<void>

$startProfile

Parameters

Returns Promise<string>

$terminalClosed

Parameters

Returns void

$terminalCreated

Parameters

Returns void

$terminalNameChanged

Parameters

Returns void

$terminalOnInput

Parameters

Returns void

$terminalOnInteraction

Parameters

Returns void

$terminalOpened

Parameters

Returns void

$terminalShellTypeChanged

Parameters

Returns void

$terminalSizeChanged

Parameters

Returns void

attachPtyToTerminal

Parameters

Returns void

createTerminal

Parameters

Returns Terminal

getEnvironmentVariableCollection

Parameters

Returns GlobalEnvironmentVariableCollection

`Protected`environmentVariableCollections

`Readonly`onDidChangeActiveTerminal

`Readonly`onDidChangeShell

`Readonly`onDidChangeTerminalState

`Readonly`onDidCloseTerminal

`Readonly`onDidOpenTerminal

`Protected`isExtensionTerminalOptions

`Protected`obtainTerminal