Theia API Documentation v1.65.0
Eclipse Theia Website
GitHub
Preparing search index...
@theia/plugin-ext
common/plugin-api-rpc
WorkspaceExt
Interface WorkspaceExt
interface
WorkspaceExt
{
$disposeCanonicalUriProvider
(
scheme
:
string
)
:
void
;
$onTextSearchResult
(
searchRequestId
:
number
,
done
:
boolean
,
result
?:
SearchInWorkspaceResult
,
)
:
void
;
$onWorkspaceFoldersChanged
(
event
:
WorkspaceRootsChangeEvent
)
:
void
;
$onWorkspaceLocationChanged
(
event
:
undefined
|
FileStat
)
:
void
;
$onWorkspaceTrustChanged
(
trust
:
undefined
|
boolean
)
:
void
;
$provideCanonicalUri
(
uri
:
string
,
targetScheme
:
string
,
token
:
CancellationToken
,
)
:
Promise
<
undefined
|
string
>
;
$provideTextDocumentContent
(
uri
:
string
,
)
:
Promise
<
undefined
|
null
|
string
>
;
$registerEditSessionIdentityProvider
(
scheme
:
string
,
provider
:
EditSessionIdentityProvider
,
)
:
Disposable
;
getCanonicalUri
(
uri
:
Uri
,
options
:
CanonicalUriRequestOptions
,
token
:
CancellationToken
,
)
:
ProviderResult
<
Uri
>
;
registerCanonicalUriProvider
(
scheme
:
string
,
provider
:
CanonicalUriProvider
,
)
:
Disposable
;
}
Implemented by
WorkspaceExtImpl
Index
Methods
$dispose
Canonical
Uri
Provider
$on
Text
Search
Result
$on
Workspace
Folders
Changed
$on
Workspace
Location
Changed
$on
Workspace
Trust
Changed
$provide
Canonical
Uri
$provide
Text
Document
Content
$register
Edit
Session
Identity
Provider
get
Canonical
Uri
register
Canonical
Uri
Provider
Methods
$dispose
Canonical
Uri
Provider
$disposeCanonicalUriProvider
(
scheme
:
string
)
:
void
Parameters
scheme
:
string
Returns
void
$on
Text
Search
Result
$onTextSearchResult
(
searchRequestId
:
number
,
done
:
boolean
,
result
?:
SearchInWorkspaceResult
,
)
:
void
Parameters
searchRequestId
:
number
done
:
boolean
Optional
result
:
SearchInWorkspaceResult
Returns
void
$on
Workspace
Folders
Changed
$onWorkspaceFoldersChanged
(
event
:
WorkspaceRootsChangeEvent
)
:
void
Parameters
event
:
WorkspaceRootsChangeEvent
Returns
void
$on
Workspace
Location
Changed
$onWorkspaceLocationChanged
(
event
:
undefined
|
FileStat
)
:
void
Parameters
event
:
undefined
|
FileStat
Returns
void
$on
Workspace
Trust
Changed
$onWorkspaceTrustChanged
(
trust
:
undefined
|
boolean
)
:
void
Parameters
trust
:
undefined
|
boolean
Returns
void
$provide
Canonical
Uri
$provideCanonicalUri
(
uri
:
string
,
targetScheme
:
string
,
token
:
CancellationToken
,
)
:
Promise
<
undefined
|
string
>
Parameters
uri
:
string
targetScheme
:
string
token
:
CancellationToken
Returns
Promise
<
undefined
|
string
>
$provide
Text
Document
Content
$provideTextDocumentContent
(
uri
:
string
)
:
Promise
<
undefined
|
null
|
string
>
Parameters
uri
:
string
Returns
Promise
<
undefined
|
null
|
string
>
$register
Edit
Session
Identity
Provider
$registerEditSessionIdentityProvider
(
scheme
:
string
,
provider
:
EditSessionIdentityProvider
,
)
:
Disposable
Parameters
scheme
:
string
provider
:
EditSessionIdentityProvider
Returns
Disposable
get
Canonical
Uri
getCanonicalUri
(
uri
:
Uri
,
options
:
CanonicalUriRequestOptions
,
token
:
CancellationToken
,
)
:
ProviderResult
<
Uri
>
Parameters
uri
:
Uri
options
:
CanonicalUriRequestOptions
token
:
CancellationToken
Returns
ProviderResult
<
Uri
>
register
Canonical
Uri
Provider
registerCanonicalUriProvider
(
scheme
:
string
,
provider
:
CanonicalUriProvider
,
)
:
Disposable
Parameters
scheme
:
string
provider
:
CanonicalUriProvider
Returns
Disposable
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
$dispose
Canonical
Uri
Provider
$on
Text
Search
Result
$on
Workspace
Folders
Changed
$on
Workspace
Location
Changed
$on
Workspace
Trust
Changed
$provide
Canonical
Uri
$provide
Text
Document
Content
$register
Edit
Session
Identity
Provider
get
Canonical
Uri
register
Canonical
Uri
Provider
Eclipse Theia Website
GitHub
Theia API Documentation v1.65.0
Loading...