Theia API Documentation v1.65.0
Eclipse Theia Website
GitHub
Preparing search index...
@theia/plugin-ext
common/plugin-api-rpc
TerminalServiceExt
Interface TerminalServiceExt
interface
TerminalServiceExt
{
$currentTerminalChanged
(
id
:
undefined
|
string
)
:
void
;
$handleTerminalLink
(
link
:
ProvidedTerminalLink
)
:
Promise
<
void
>
;
$initEnvironmentVariableCollections
(
collections
:
[
string
,
string
,
boolean
,
SerializableEnvironmentVariableCollection
,
]
[]
,
)
:
void
;
$provideTerminalLinks
(
line
:
string
,
terminalId
:
string
,
token
:
CancellationToken
,
)
:
Promise
<
ProvidedTerminalLink
[]
>
;
$reportOutputMatch
(
observerId
:
string
,
groups
:
string
[]
)
:
void
;
$setShell
(
shell
:
string
)
:
void
;
$startProfile
(
providerId
:
string
,
cancellationToken
:
CancellationToken
,
)
:
Promise
<
string
>
;
$terminalClosed
(
id
:
string
,
exitStatus
:
undefined
|
TerminalExitStatus
,
)
:
void
;
$terminalCreated
(
id
:
string
,
name
:
string
)
:
void
;
$terminalNameChanged
(
id
:
string
,
name
:
string
)
:
void
;
$terminalOnInput
(
id
:
string
,
data
:
string
)
:
void
;
$terminalOnInteraction
(
id
:
string
)
:
void
;
$terminalOpened
(
id
:
string
,
processId
:
number
,
terminalId
:
number
,
cols
:
number
,
rows
:
number
,
)
:
void
;
$terminalShellTypeChanged
(
id
:
string
,
newShellType
:
string
)
:
void
;
$terminalSizeChanged
(
id
:
string
,
cols
:
number
,
rows
:
number
)
:
void
;
getEnvironmentVariableCollection
(
extensionIdentifier
:
string
,
)
:
GlobalEnvironmentVariableCollection
;
}
Implemented by
TerminalServiceExtImpl
Index
Methods
$current
Terminal
Changed
$handle
Terminal
Link
$init
Environment
Variable
Collections
$provide
Terminal
Links
$report
Output
Match
$set
Shell
$start
Profile
$terminal
Closed
$terminal
Created
$terminal
Name
Changed
$terminal
On
Input
$terminal
On
Interaction
$terminal
Opened
$terminal
Shell
Type
Changed
$terminal
Size
Changed
get
Environment
Variable
Collection
Methods
$current
Terminal
Changed
$currentTerminalChanged
(
id
:
undefined
|
string
)
:
void
Parameters
id
:
undefined
|
string
Returns
void
$handle
Terminal
Link
$handleTerminalLink
(
link
:
ProvidedTerminalLink
)
:
Promise
<
void
>
Parameters
link
:
ProvidedTerminalLink
Returns
Promise
<
void
>
$init
Environment
Variable
Collections
$initEnvironmentVariableCollections
(
collections
:
[
string
,
string
,
boolean
,
SerializableEnvironmentVariableCollection
,
]
[]
,
)
:
void
Parameters
collections
:
[
string
,
string
,
boolean
,
SerializableEnvironmentVariableCollection
]
[]
Returns
void
$provide
Terminal
Links
$provideTerminalLinks
(
line
:
string
,
terminalId
:
string
,
token
:
CancellationToken
,
)
:
Promise
<
ProvidedTerminalLink
[]
>
Parameters
line
:
string
terminalId
:
string
token
:
CancellationToken
Returns
Promise
<
ProvidedTerminalLink
[]
>
$report
Output
Match
$reportOutputMatch
(
observerId
:
string
,
groups
:
string
[]
)
:
void
Parameters
observerId
:
string
groups
:
string
[]
Returns
void
$set
Shell
$setShell
(
shell
:
string
)
:
void
Parameters
shell
:
string
Returns
void
$start
Profile
$startProfile
(
providerId
:
string
,
cancellationToken
:
CancellationToken
,
)
:
Promise
<
string
>
Parameters
providerId
:
string
cancellationToken
:
CancellationToken
Returns
Promise
<
string
>
$terminal
Closed
$terminalClosed
(
id
:
string
,
exitStatus
:
undefined
|
TerminalExitStatus
)
:
void
Parameters
id
:
string
exitStatus
:
undefined
|
TerminalExitStatus
Returns
void
$terminal
Created
$terminalCreated
(
id
:
string
,
name
:
string
)
:
void
Parameters
id
:
string
name
:
string
Returns
void
$terminal
Name
Changed
$terminalNameChanged
(
id
:
string
,
name
:
string
)
:
void
Parameters
id
:
string
name
:
string
Returns
void
$terminal
On
Input
$terminalOnInput
(
id
:
string
,
data
:
string
)
:
void
Parameters
id
:
string
data
:
string
Returns
void
$terminal
On
Interaction
$terminalOnInteraction
(
id
:
string
)
:
void
Parameters
id
:
string
Returns
void
$terminal
Opened
$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
$terminal
Shell
Type
Changed
$terminalShellTypeChanged
(
id
:
string
,
newShellType
:
string
)
:
void
Parameters
id
:
string
newShellType
:
string
Returns
void
$terminal
Size
Changed
$terminalSizeChanged
(
id
:
string
,
cols
:
number
,
rows
:
number
)
:
void
Parameters
id
:
string
cols
:
number
rows
:
number
Returns
void
get
Environment
Variable
Collection
getEnvironmentVariableCollection
(
extensionIdentifier
:
string
,
)
:
GlobalEnvironmentVariableCollection
Parameters
extensionIdentifier
:
string
Returns
GlobalEnvironmentVariableCollection
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
$current
Terminal
Changed
$handle
Terminal
Link
$init
Environment
Variable
Collections
$provide
Terminal
Links
$report
Output
Match
$set
Shell
$start
Profile
$terminal
Closed
$terminal
Created
$terminal
Name
Changed
$terminal
On
Input
$terminal
On
Interaction
$terminal
Opened
$terminal
Shell
Type
Changed
$terminal
Size
Changed
get
Environment
Variable
Collection
Eclipse Theia Website
GitHub
Theia API Documentation v1.65.0
Loading...