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

Methods

Constructors

constructor

new TerminalServiceExtImpl(rpc: RPCProtocol): TerminalServiceExtImpl

- Defined in packages/plugin-ext/src/plugin/terminal-ext.ts:47
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 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

Accessors

activeTerminal

get activeTerminal(): undefined | TerminalExtImpl

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

terminals

get terminals(): TerminalExtImpl[]

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

Methods

$currentTerminalChanged

$currentTerminalChanged(id: undefined | string): void

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

$initEnvironmentVariableCollections

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

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

$terminalClosed

$terminalClosed(id: string): void

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

$terminalCreated

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

Implementation of TerminalServiceExt.$terminalCreated
- Defined in packages/plugin-ext/src/plugin/terminal-ext.ts:112
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:118
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:96
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:125
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:104
Parameters
- id: string
- clos: number
- rows: number
Returns void

attachPtyToTerminal

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

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

createTerminal

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

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

getEnvironmentVariableCollection

getEnvironmentVariableCollection(extensionIdentifier: string): EnvironmentVariableCollection

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

Protected obtainTerminal

obtainTerminal(id: string, name: string): TerminalExtImpl

- Defined in packages/plugin-ext/src/plugin/terminal-ext.ts:86
Parameters
- id: string
- name: string
Returns TerminalExtImpl

Private setEnvironmentVariableCollection

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

- Defined in packages/plugin-ext/src/plugin/terminal-ext.ts:182
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:177
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 onDidCloseTerminal

Private Readonly onDidCloseTerminalEmitter

Readonly onDidOpenTerminal

Private Readonly onDidOpenTerminalEmitter

Private Readonly proxy

Accessors

activeTerminal

Returns undefined | TerminalExtImpl

terminals

Returns TerminalExtImpl[]

Methods

$currentTerminalChanged

Parameters

id: undefined | string

Returns void

$initEnvironmentVariableCollections

Parameters

collections: [string, SerializableEnvironmentVariableCollection][]

Returns void

$terminalClosed

Parameters

id: string

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

id: string

processId: number

terminalId: number

cols: number

rows: number

Returns void

$terminalSizeChanged

Parameters

id: string

clos: number

rows: number

Returns void

attachPtyToTerminal

Parameters

terminalId: number

pty: Pseudoterminal

Returns void

createTerminal

Parameters

nameOrOptions: undefined | string | TerminalOptions | PseudoTerminalOptions

Optional shellPath: string