Theia API Documentation v1.65.0
Eclipse Theia Website
GitHub
Preparing search index...
@theia/plugin-ext
common/plugin-api-rpc
DebugExt
Interface DebugExt
interface
DebugExt
{
$breakpointsDidChange
(
added
:
Breakpoint
[]
,
removed
:
string
[]
,
changed
:
Breakpoint
[]
,
)
:
void
;
$createDebugSession
(
debugConfiguration
:
DebugConfiguration
,
workspaceFolder
:
undefined
|
string
,
)
:
Promise
<
string
>
;
$getTerminalCreationOptions
(
debugType
:
string
,
)
:
Promise
<
undefined
|
TerminalOptionsExt
>
;
$onDidChangeActiveFrame
(
frame
:
undefined
|
DebugStackFrameDTO
)
:
void
;
$onDidChangeActiveThread
(
thread
:
undefined
|
DebugThreadDTO
)
:
void
;
$onSessionCustomEvent
(
sessionId
:
string
,
event
:
string
,
body
?:
any
)
:
void
;
$provideDebugConfigurationsByHandle
(
handle
:
number
,
workspaceFolder
:
undefined
|
string
,
)
:
Promise
<
DebugConfiguration
[]
>
;
$resolveDebugConfigurationByHandle
(
handle
:
number
,
workspaceFolder
:
undefined
|
string
,
debugConfiguration
:
DebugConfiguration
,
)
:
Promise
<
undefined
|
null
|
DebugConfiguration
>
;
$resolveDebugConfigurationWithSubstitutedVariablesByHandle
(
handle
:
number
,
workspaceFolder
:
undefined
|
string
,
debugConfiguration
:
DebugConfiguration
,
)
:
Promise
<
undefined
|
null
|
DebugConfiguration
>
;
$sessionDidChange
(
sessionId
:
undefined
|
string
)
:
void
;
$sessionDidCreate
(
sessionId
:
string
)
:
void
;
$sessionDidDestroy
(
sessionId
:
string
)
:
void
;
$sessionDidStart
(
sessionId
:
string
)
:
void
;
$terminateDebugSession
(
sessionId
:
string
)
:
Promise
<
void
>
;
}
Implemented by
DebugExtImpl
Index
Methods
$breakpoints
Did
Change
$create
Debug
Session
$get
Terminal
Creation
Options
$on
Did
Change
Active
Frame
$on
Did
Change
Active
Thread
$on
Session
Custom
Event
$provide
Debug
Configurations
By
Handle
$resolve
Debug
Configuration
By
Handle
$resolve
Debug
Configuration
With
Substituted
Variables
By
Handle
$session
Did
Change
$session
Did
Create
$session
Did
Destroy
$session
Did
Start
$terminate
Debug
Session
Methods
$breakpoints
Did
Change
$breakpointsDidChange
(
added
:
Breakpoint
[]
,
removed
:
string
[]
,
changed
:
Breakpoint
[]
,
)
:
void
Parameters
added
:
Breakpoint
[]
removed
:
string
[]
changed
:
Breakpoint
[]
Returns
void
$create
Debug
Session
$createDebugSession
(
debugConfiguration
:
DebugConfiguration
,
workspaceFolder
:
undefined
|
string
,
)
:
Promise
<
string
>
Parameters
debugConfiguration
:
DebugConfiguration
workspaceFolder
:
undefined
|
string
Returns
Promise
<
string
>
$get
Terminal
Creation
Options
$getTerminalCreationOptions
(
debugType
:
string
,
)
:
Promise
<
undefined
|
TerminalOptionsExt
>
Parameters
debugType
:
string
Returns
Promise
<
undefined
|
TerminalOptionsExt
>
$on
Did
Change
Active
Frame
$onDidChangeActiveFrame
(
frame
:
undefined
|
DebugStackFrameDTO
)
:
void
Parameters
frame
:
undefined
|
DebugStackFrameDTO
Returns
void
$on
Did
Change
Active
Thread
$onDidChangeActiveThread
(
thread
:
undefined
|
DebugThreadDTO
)
:
void
Parameters
thread
:
undefined
|
DebugThreadDTO
Returns
void
$on
Session
Custom
Event
$onSessionCustomEvent
(
sessionId
:
string
,
event
:
string
,
body
?:
any
)
:
void
Parameters
sessionId
:
string
event
:
string
Optional
body
:
any
Returns
void
$provide
Debug
Configurations
By
Handle
$provideDebugConfigurationsByHandle
(
handle
:
number
,
workspaceFolder
:
undefined
|
string
,
)
:
Promise
<
DebugConfiguration
[]
>
Parameters
handle
:
number
workspaceFolder
:
undefined
|
string
Returns
Promise
<
DebugConfiguration
[]
>
$resolve
Debug
Configuration
By
Handle
$resolveDebugConfigurationByHandle
(
handle
:
number
,
workspaceFolder
:
undefined
|
string
,
debugConfiguration
:
DebugConfiguration
,
)
:
Promise
<
undefined
|
null
|
DebugConfiguration
>
Parameters
handle
:
number
workspaceFolder
:
undefined
|
string
debugConfiguration
:
DebugConfiguration
Returns
Promise
<
undefined
|
null
|
DebugConfiguration
>
$resolve
Debug
Configuration
With
Substituted
Variables
By
Handle
$resolveDebugConfigurationWithSubstitutedVariablesByHandle
(
handle
:
number
,
workspaceFolder
:
undefined
|
string
,
debugConfiguration
:
DebugConfiguration
,
)
:
Promise
<
undefined
|
null
|
DebugConfiguration
>
Parameters
handle
:
number
workspaceFolder
:
undefined
|
string
debugConfiguration
:
DebugConfiguration
Returns
Promise
<
undefined
|
null
|
DebugConfiguration
>
$session
Did
Change
$sessionDidChange
(
sessionId
:
undefined
|
string
)
:
void
Parameters
sessionId
:
undefined
|
string
Returns
void
$session
Did
Create
$sessionDidCreate
(
sessionId
:
string
)
:
void
Parameters
sessionId
:
string
Returns
void
$session
Did
Destroy
$sessionDidDestroy
(
sessionId
:
string
)
:
void
Parameters
sessionId
:
string
Returns
void
$session
Did
Start
$sessionDidStart
(
sessionId
:
string
)
:
void
Parameters
sessionId
:
string
Returns
void
$terminate
Debug
Session
$terminateDebugSession
(
sessionId
:
string
)
:
Promise
<
void
>
Parameters
sessionId
:
string
Returns
Promise
<
void
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
$breakpoints
Did
Change
$create
Debug
Session
$get
Terminal
Creation
Options
$on
Did
Change
Active
Frame
$on
Did
Change
Active
Thread
$on
Session
Custom
Event
$provide
Debug
Configurations
By
Handle
$resolve
Debug
Configuration
By
Handle
$resolve
Debug
Configuration
With
Substituted
Variables
By
Handle
$session
Did
Change
$session
Did
Create
$session
Did
Destroy
$session
Did
Start
$terminate
Debug
Session
Eclipse Theia Website
GitHub
Theia API Documentation v1.65.0
Loading...