TerminalServiceExtImpl | Theia TypeDoc

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

Hierarchy

TerminalServiceExtImpl

Implements

TerminalServiceExt

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new TerminalServiceExtImpl(rpc: RPCProtocol): TerminalServiceExtImpl

- Defined in packages/plugin-ext/src/plugin/terminal-ext.ts:72
Parameters
- rpc: RPCProtocol
Returns TerminalServiceExtImpl

Properties

Private Readonly _pseudoTerminals

_pseudoTerminals: Map<string, PseudoTerminal> = ...

Private Readonly _terminals

_terminals: Map<string, TerminalExtImpl> = ...

Private activeTerminalId

activeTerminalId: undefined | string

Protected environmentVariableCollections

environmentVariableCollections: Map<string, EnvironmentVariableCollection> = ...

Readonly onDidChangeActiveTerminal

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

Private Readonly onDidChangeActiveTerminalEmitter

onDidChangeActiveTerminalEmitter: Emitter<undefined | Terminal> = ...

Readonly onDidChangeTerminalState

onDidChangeTerminalState: Event<Terminal> = ...

Private Readonly onDidChangeTerminalStateEmitter

onDidChangeTerminalStateEmitter: Emitter<Terminal> = ...

Readonly onDidCloseTerminal

onDidCloseTerminal: Event<Terminal> = ...

Private Readonly onDidCloseTerminalEmitter

onDidCloseTerminalEmitter: Emitter<Terminal> = ...

Readonly onDidOpenTerminal

onDidOpenTerminal: Event<Terminal> = ...

Private Readonly onDidOpenTerminalEmitter

onDidOpenTerminalEmitter: Emitter<Terminal> = ...

Private Readonly proxy

proxy: TerminalServiceMain

Private Readonly terminalLinkProviders

terminalLinkProviders: Map<string, TerminalLinkProvider<TerminalLink>> = ...

Private Readonly terminalProfileProviders

terminalProfileProviders: Map<string, TerminalProfileProvider> = ...

Static Private nextProviderId

nextProviderId: number = 0

Accessors

activeTerminal

get activeTerminal(): undefined | TerminalExtImpl

- Defined in packages/plugin-ext/src/plugin/terminal-ext.ts:224
Returns undefined | TerminalExtImpl

terminals

get terminals(): TerminalExtImpl[]

- Defined in packages/plugin-ext/src/plugin/terminal-ext.ts:76
Returns TerminalExtImpl[]

Methods

$currentTerminalChanged

$currentTerminalChanged(id: undefined | string): void

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

$handleTerminalLink

$handleTerminalLink(link: ProvidedTerminalLink): Promise<void>

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

$initEnvironmentVariableCollections

$initEnvironmentVariableCollections(collections: [string, SerializableEnvironmentVariableCollection][]): void

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

$provideTerminalLinks

$provideTerminalLinks(line: string, terminalId: string, token: CancellationToken): Promise<ProvidedTerminalLink[]>

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

$startProfile

$startProfile(profileId: string, cancellationToken: CancellationToken): Promise<string>

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

$terminalClosed

$terminalClosed(id: string, exitStatus: undefined | TerminalExitStatus): void

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

$terminalCreated

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

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

$terminalNameChanged

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

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

$terminalOnInput

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

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

$terminalOpened

$terminalOpened(id: string, processId: number, terminalId: number, cols: number, rows: number): void

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

$terminalSizeChanged

$terminalSizeChanged(id: string, clos: number, rows: number): void

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

$terminalStateChanged

$terminalStateChanged(id: string): void

Implementation of TerminalServiceExt.$terminalStateChanged
- Defined in packages/plugin-ext/src/plugin/terminal-ext.ts:151
Parameters
- id: string
Returns void

attachPtyToTerminal

attachPtyToTerminal(terminalId: number, pty: Pseudoterminal): void

- Defined in packages/plugin-ext/src/plugin/terminal-ext.ts:129
Parameters
- terminalId: number
- pty: Pseudoterminal
Returns void

createTerminal

createTerminal(nameOrOptions: undefined | string | TerminalOptions | ExtensionTerminalOptions | PseudoTerminalOptions, shellPath?: string, shellArgs?: string | string[]): Terminal

- Defined in packages/plugin-ext/src/plugin/terminal-ext.ts:80
Parameters
- nameOrOptions: undefined | string | TerminalOptions | ExtensionTerminalOptions | PseudoTerminalOptions
- Optional shellPath: string
- Optional shellArgs: string | string[]
Returns Terminal

getEnvironmentVariableCollection

getEnvironmentVariableCollection(extensionIdentifier: string): EnvironmentVariableCollection

Implementation of TerminalServiceExt.getEnvironmentVariableCollection
- Defined in packages/plugin-ext/src/plugin/terminal-ext.ts:305
Parameters
- extensionIdentifier: string
Returns EnvironmentVariableCollection

Protected isExtensionTerminalOptions

isExtensionTerminalOptions(options: TerminalOptions | ExtensionTerminalOptions): options is ExtensionTerminalOptions

- Defined in packages/plugin-ext/src/plugin/terminal-ext.ts:254
Parameters
- options: TerminalOptions | ExtensionTerminalOptions
Returns options is ExtensionTerminalOptions

Protected obtainTerminal

obtainTerminal(id: string, name: string, options?: TerminalOptions | ExtensionTerminalOptions): TerminalExtImpl

- Defined in packages/plugin-ext/src/plugin/terminal-ext.ts:133
Parameters
- id: string
- name: string
- Optional options: TerminalOptions | ExtensionTerminalOptions
Returns TerminalExtImpl

registerTerminalLinkProvider

registerTerminalLinkProvider(provider: TerminalLinkProvider<TerminalLink>): Disposable

- Defined in packages/plugin-ext/src/plugin/terminal-ext.ts:232
Parameters
- provider: TerminalLinkProvider<TerminalLink>
Returns Disposable

registerTerminalProfileProvider

registerTerminalProfileProvider(id: string, provider: TerminalProfileProvider): Disposable

- Defined in packages/plugin-ext/src/plugin/terminal-ext.ts:242
Parameters
- id: string
- provider: TerminalProfileProvider
Returns Disposable

registerTerminalQuickFixProvider

registerTerminalQuickFixProvider(id: string, provider: TerminalQuickFixProvider): Disposable

- Defined in packages/plugin-ext/src/plugin/terminal-ext.ts:250
stubbed
Parameters
- id: string
- provider: TerminalQuickFixProvider
Returns Disposable

Private setEnvironmentVariableCollection

setEnvironmentVariableCollection(extensionIdentifier: string, collection: EnvironmentVariableCollection): void

- Defined in packages/plugin-ext/src/plugin/terminal-ext.ts:319
Parameters
- extensionIdentifier: string
- collection: EnvironmentVariableCollection
Returns void

Private syncEnvironmentVariableCollection

syncEnvironmentVariableCollection(extensionIdentifier: string, collection: EnvironmentVariableCollection): void

- Defined in packages/plugin-ext/src/plugin/terminal-ext.ts:314
Parameters
- extensionIdentifier: string
- collection: EnvironmentVariableCollection
Returns void

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

rpc: RPCProtocol

Returns TerminalServiceExtImpl

Properties

Private Readonly _pseudoTerminals

Private Readonly _terminals

Private activeTerminalId

Protected environmentVariableCollections

Readonly onDidChangeActiveTerminal

Private Readonly onDidChangeActiveTerminalEmitter

Readonly onDidChangeTerminalState

Private Readonly onDidChangeTerminalStateEmitter

Readonly onDidCloseTerminal

Private Readonly onDidCloseTerminalEmitter

Readonly onDidOpenTerminal

Private Readonly onDidOpenTerminalEmitter

Private Readonly proxy

Private Readonly terminalLinkProviders

Private Readonly terminalProfileProviders

Static Private nextProviderId

Accessors

activeTerminal

Returns undefined | TerminalExtImpl

terminals

Returns TerminalExtImpl[]

Methods

$currentTerminalChanged

Parameters

id: undefined | string

Returns void

$handleTerminalLink

Parameters

link: ProvidedTerminalLink

Returns Promise<void>

$initEnvironmentVariableCollections

Parameters

collections: [string, SerializableEnvironmentVariableCollection][]

Returns void

$provideTerminalLinks

Parameters

line: string

terminalId: string

token: CancellationToken

Returns Promise<ProvidedTerminalLink[]>

$startProfile

Parameters

profileId: string

cancellationToken: CancellationToken

Returns Promise<string>

$terminalClosed

Parameters

id: string

exitStatus: undefined | TerminalExitStatus

Returns void

$terminalCreated

Parameters

id: string

name: string

Returns void

$terminalNameChanged

Parameters

id: string

name: string

Returns void

$terminalOnInput

Parameters

id: string

data: string

Returns void

$terminalOpened

Parameters