Theia API Documentation v1.77.0
Eclipse Theia Website
GitHub
Preparing search index...
@theia/plugin-ext-headless
common/headless-plugin-protocol
ScmExt
Interface ScmExt
interface
ScmExt
{
$executeResourceCommand
(
sourceControlHandle
:
number
,
groupHandle
:
number
,
resourceHandle
:
number
,
)
:
Promise
<
void
>
;
$onInputBoxValueChange
(
sourceControlHandle
:
number
,
message
:
string
,
)
:
Promise
<
void
>
;
$provideHistoryItemChanges
(
sourceControlHandle
:
number
,
historyItemId
:
string
,
historyItemParentId
:
string
|
undefined
,
token
:
CancellationToken
,
)
:
Promise
<
ScmHistoryItemChangeDto
[]
|
undefined
>
;
$provideHistoryItemRefs
(
sourceControlHandle
:
number
,
historyItemRefs
:
string
[]
|
undefined
,
token
:
CancellationToken
,
)
:
Promise
<
ScmHistoryItemRefDto
[]
|
undefined
>
;
$provideHistoryItems
(
sourceControlHandle
:
number
,
options
:
ScmHistoryOptionsDto
,
token
:
CancellationToken
,
)
:
Promise
<
ScmHistoryItemDto
[]
|
undefined
>
;
$provideOriginalResource
(
sourceControlHandle
:
number
,
uri
:
string
,
token
:
CancellationToken
,
)
:
Promise
<
UriComponents
|
undefined
>
;
$resolveHistoryItem
(
sourceControlHandle
:
number
,
historyItemId
:
string
,
token
:
CancellationToken
,
)
:
Promise
<
ScmHistoryItemDto
|
undefined
>
;
$resolveHistoryItemRefsCommonAncestor
(
sourceControlHandle
:
number
,
historyItemRefs
:
string
[]
,
token
:
CancellationToken
,
)
:
Promise
<
string
|
undefined
>
;
$setSelectedSourceControl
(
selectedSourceControlHandle
:
number
|
undefined
,
)
:
Promise
<
void
>
;
$validateInput
(
sourceControlHandle
:
number
,
value
:
string
,
cursorPosition
:
number
,
)
:
Promise
<
[
string
,
number
]
|
undefined
>
;
createSourceControl
(
plugin
:
Plugin
,
id
:
string
,
label
:
string
,
rootUri
?:
Uri
,
)
:
SourceControl
;
getLastInputBox
(
plugin
:
Plugin
)
:
SourceControlInputBox
|
undefined
;
}
Index
Methods
$execute
Resource
Command
$on
Input
Box
Value
Change
$provide
History
Item
Changes
$provide
History
Item
Refs
$provide
History
Items
$provide
Original
Resource
$resolve
History
Item
$resolve
History
Item
Refs
Common
Ancestor
$set
Selected
Source
Control
$validate
Input
create
Source
Control
get
Last
Input
Box
Methods
$execute
Resource
Command
$executeResourceCommand
(
sourceControlHandle
:
number
,
groupHandle
:
number
,
resourceHandle
:
number
,
)
:
Promise
<
void
>
Parameters
sourceControlHandle
:
number
groupHandle
:
number
resourceHandle
:
number
Returns
Promise
<
void
>
$on
Input
Box
Value
Change
$onInputBoxValueChange
(
sourceControlHandle
:
number
,
message
:
string
,
)
:
Promise
<
void
>
Parameters
sourceControlHandle
:
number
message
:
string
Returns
Promise
<
void
>
$provide
History
Item
Changes
$provideHistoryItemChanges
(
sourceControlHandle
:
number
,
historyItemId
:
string
,
historyItemParentId
:
string
|
undefined
,
token
:
CancellationToken
,
)
:
Promise
<
ScmHistoryItemChangeDto
[]
|
undefined
>
Parameters
sourceControlHandle
:
number
historyItemId
:
string
historyItemParentId
:
string
|
undefined
token
:
CancellationToken
Returns
Promise
<
ScmHistoryItemChangeDto
[]
|
undefined
>
$provide
History
Item
Refs
$provideHistoryItemRefs
(
sourceControlHandle
:
number
,
historyItemRefs
:
string
[]
|
undefined
,
token
:
CancellationToken
,
)
:
Promise
<
ScmHistoryItemRefDto
[]
|
undefined
>
Parameters
sourceControlHandle
:
number
historyItemRefs
:
string
[]
|
undefined
token
:
CancellationToken
Returns
Promise
<
ScmHistoryItemRefDto
[]
|
undefined
>
$provide
History
Items
$provideHistoryItems
(
sourceControlHandle
:
number
,
options
:
ScmHistoryOptionsDto
,
token
:
CancellationToken
,
)
:
Promise
<
ScmHistoryItemDto
[]
|
undefined
>
Parameters
sourceControlHandle
:
number
options
:
ScmHistoryOptionsDto
token
:
CancellationToken
Returns
Promise
<
ScmHistoryItemDto
[]
|
undefined
>
$provide
Original
Resource
$provideOriginalResource
(
sourceControlHandle
:
number
,
uri
:
string
,
token
:
CancellationToken
,
)
:
Promise
<
UriComponents
|
undefined
>
Parameters
sourceControlHandle
:
number
uri
:
string
token
:
CancellationToken
Returns
Promise
<
UriComponents
|
undefined
>
$resolve
History
Item
$resolveHistoryItem
(
sourceControlHandle
:
number
,
historyItemId
:
string
,
token
:
CancellationToken
,
)
:
Promise
<
ScmHistoryItemDto
|
undefined
>
Parameters
sourceControlHandle
:
number
historyItemId
:
string
token
:
CancellationToken
Returns
Promise
<
ScmHistoryItemDto
|
undefined
>
$resolve
History
Item
Refs
Common
Ancestor
$resolveHistoryItemRefsCommonAncestor
(
sourceControlHandle
:
number
,
historyItemRefs
:
string
[]
,
token
:
CancellationToken
,
)
:
Promise
<
string
|
undefined
>
Parameters
sourceControlHandle
:
number
historyItemRefs
:
string
[]
token
:
CancellationToken
Returns
Promise
<
string
|
undefined
>
$set
Selected
Source
Control
$setSelectedSourceControl
(
selectedSourceControlHandle
:
number
|
undefined
,
)
:
Promise
<
void
>
Parameters
selectedSourceControlHandle
:
number
|
undefined
Returns
Promise
<
void
>
$validate
Input
$validateInput
(
sourceControlHandle
:
number
,
value
:
string
,
cursorPosition
:
number
,
)
:
Promise
<
[
string
,
number
]
|
undefined
>
Parameters
sourceControlHandle
:
number
value
:
string
cursorPosition
:
number
Returns
Promise
<
[
string
,
number
]
|
undefined
>
create
Source
Control
createSourceControl
(
plugin
:
Plugin
,
id
:
string
,
label
:
string
,
rootUri
?:
Uri
,
)
:
SourceControl
Parameters
plugin
:
Plugin
id
:
string
label
:
string
Optional
rootUri
:
Uri
Returns
SourceControl
get
Last
Input
Box
getLastInputBox
(
plugin
:
Plugin
)
:
SourceControlInputBox
|
undefined
Parameters
plugin
:
Plugin
Returns
SourceControlInputBox
|
undefined
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
$execute
Resource
Command
$on
Input
Box
Value
Change
$provide
History
Item
Changes
$provide
History
Item
Refs
$provide
History
Items
$provide
Original
Resource
$resolve
History
Item
$resolve
History
Item
Refs
Common
Ancestor
$set
Selected
Source
Control
$validate
Input
create
Source
Control
get
Last
Input
Box
Eclipse Theia Website
GitHub
Theia API Documentation v1.77.0
Loading...