Theia API Documentation v1.65.0
Eclipse Theia Website
GitHub
Preparing search index...
@theia/plugin-ext
common/plugin-api-rpc
WorkspaceMain
Interface WorkspaceMain
interface
WorkspaceMain
{
$findTextInFiles
(
query
:
TextSearchQuery
,
options
:
FindTextInFilesOptions
,
searchRequestId
:
number
,
token
?:
CancellationToken
,
)
:
Promise
<
TextSearchComplete
>
;
$getCanonicalUri
(
uri
:
string
,
targetScheme
:
string
,
token
:
CancellationToken
,
)
:
Promise
<
undefined
|
string
>
;
$getValidEncoding
(
uri
:
undefined
|
UriComponents
,
detectedEncoding
:
undefined
|
string
,
opts
:
undefined
|
{
encoding
:
string
}
,
)
:
Promise
<
string
>
;
$getWorkspace
()
:
Promise
<
undefined
|
FileStat
>
;
$onTextDocumentContentChange
(
uri
:
string
,
content
:
string
)
:
void
;
$pickWorkspaceFolder
(
options
:
WorkspaceFolderPickOptionsMain
,
)
:
Promise
<
undefined
|
WorkspaceFolder
>
;
$registerCanonicalUriProvider
(
scheme
:
string
)
:
Promise
<
undefined
|
void
>
;
$registerTextDocumentContentProvider
(
scheme
:
string
)
:
Promise
<
void
>
;
$requestWorkspaceTrust
(
options
?:
WorkspaceTrustRequestOptions
,
)
:
Promise
<
undefined
|
boolean
>
;
$resolveDecoding
(
resource
:
undefined
|
UriComponents
,
options
?:
{
encoding
?:
string
}
,
)
:
Promise
<
{
guessEncoding
:
boolean
;
preferredEncoding
:
string
}
>
;
$resolveEncoding
(
resource
:
undefined
|
UriComponents
,
options
?:
{
encoding
?:
string
}
,
)
:
Promise
<
{
encoding
:
string
;
hasBOM
:
boolean
}
>
;
$resolveProxy
(
url
:
string
)
:
Promise
<
undefined
|
string
>
;
$startFileSearch
(
includePattern
:
string
,
includeFolder
:
undefined
|
string
,
options
:
FindFilesOptions
,
token
:
CancellationToken
,
)
:
PromiseLike
<
UriComponents
[]
>
;
$unregisterCanonicalUriProvider
(
scheme
:
string
)
:
void
;
$unregisterTextDocumentContentProvider
(
scheme
:
string
)
:
void
;
$updateWorkspaceFolders
(
start
:
number
,
deleteCount
?:
number
,
...
rootsToAdd
:
string
[]
,
)
:
Promise
<
void
>
;
}
Implemented by
WorkspaceMainImpl
Index
Methods
$find
Text
In
Files
$get
Canonical
Uri
$get
Valid
Encoding
$get
Workspace
$on
Text
Document
Content
Change
$pick
Workspace
Folder
$register
Canonical
Uri
Provider
$register
Text
Document
Content
Provider
$request
Workspace
Trust
$resolve
Decoding
$resolve
Encoding
$resolve
Proxy
$start
File
Search
$unregister
Canonical
Uri
Provider
$unregister
Text
Document
Content
Provider
$update
Workspace
Folders
Methods
$find
Text
In
Files
$findTextInFiles
(
query
:
TextSearchQuery
,
options
:
FindTextInFilesOptions
,
searchRequestId
:
number
,
token
?:
CancellationToken
,
)
:
Promise
<
TextSearchComplete
>
Parameters
query
:
TextSearchQuery
options
:
FindTextInFilesOptions
searchRequestId
:
number
Optional
token
:
CancellationToken
Returns
Promise
<
TextSearchComplete
>
$get
Canonical
Uri
$getCanonicalUri
(
uri
:
string
,
targetScheme
:
string
,
token
:
CancellationToken
,
)
:
Promise
<
undefined
|
string
>
Parameters
uri
:
string
targetScheme
:
string
token
:
CancellationToken
Returns
Promise
<
undefined
|
string
>
$get
Valid
Encoding
$getValidEncoding
(
uri
:
undefined
|
UriComponents
,
detectedEncoding
:
undefined
|
string
,
opts
:
undefined
|
{
encoding
:
string
}
,
)
:
Promise
<
string
>
Parameters
uri
:
undefined
|
UriComponents
detectedEncoding
:
undefined
|
string
opts
:
undefined
|
{
encoding
:
string
}
Returns
Promise
<
string
>
$get
Workspace
$getWorkspace
()
:
Promise
<
undefined
|
FileStat
>
Returns
Promise
<
undefined
|
FileStat
>
$on
Text
Document
Content
Change
$onTextDocumentContentChange
(
uri
:
string
,
content
:
string
)
:
void
Parameters
uri
:
string
content
:
string
Returns
void
$pick
Workspace
Folder
$pickWorkspaceFolder
(
options
:
WorkspaceFolderPickOptionsMain
,
)
:
Promise
<
undefined
|
WorkspaceFolder
>
Parameters
options
:
WorkspaceFolderPickOptionsMain
Returns
Promise
<
undefined
|
WorkspaceFolder
>
$register
Canonical
Uri
Provider
$registerCanonicalUriProvider
(
scheme
:
string
)
:
Promise
<
undefined
|
void
>
Parameters
scheme
:
string
Returns
Promise
<
undefined
|
void
>
$register
Text
Document
Content
Provider
$registerTextDocumentContentProvider
(
scheme
:
string
)
:
Promise
<
void
>
Parameters
scheme
:
string
Returns
Promise
<
void
>
$request
Workspace
Trust
$requestWorkspaceTrust
(
options
?:
WorkspaceTrustRequestOptions
,
)
:
Promise
<
undefined
|
boolean
>
Parameters
Optional
options
:
WorkspaceTrustRequestOptions
Returns
Promise
<
undefined
|
boolean
>
$resolve
Decoding
$resolveDecoding
(
resource
:
undefined
|
UriComponents
,
options
?:
{
encoding
?:
string
}
,
)
:
Promise
<
{
guessEncoding
:
boolean
;
preferredEncoding
:
string
}
>
Parameters
resource
:
undefined
|
UriComponents
Optional
options
:
{
encoding
?:
string
}
Returns
Promise
<
{
guessEncoding
:
boolean
;
preferredEncoding
:
string
}
>
$resolve
Encoding
$resolveEncoding
(
resource
:
undefined
|
UriComponents
,
options
?:
{
encoding
?:
string
}
,
)
:
Promise
<
{
encoding
:
string
;
hasBOM
:
boolean
}
>
Parameters
resource
:
undefined
|
UriComponents
Optional
options
:
{
encoding
?:
string
}
Returns
Promise
<
{
encoding
:
string
;
hasBOM
:
boolean
}
>
$resolve
Proxy
$resolveProxy
(
url
:
string
)
:
Promise
<
undefined
|
string
>
Parameters
url
:
string
Returns
Promise
<
undefined
|
string
>
$start
File
Search
$startFileSearch
(
includePattern
:
string
,
includeFolder
:
undefined
|
string
,
options
:
FindFilesOptions
,
token
:
CancellationToken
,
)
:
PromiseLike
<
UriComponents
[]
>
Parameters
includePattern
:
string
includeFolder
:
undefined
|
string
options
:
FindFilesOptions
token
:
CancellationToken
Returns
PromiseLike
<
UriComponents
[]
>
$unregister
Canonical
Uri
Provider
$unregisterCanonicalUriProvider
(
scheme
:
string
)
:
void
Parameters
scheme
:
string
Returns
void
$unregister
Text
Document
Content
Provider
$unregisterTextDocumentContentProvider
(
scheme
:
string
)
:
void
Parameters
scheme
:
string
Returns
void
$update
Workspace
Folders
$updateWorkspaceFolders
(
start
:
number
,
deleteCount
?:
number
,
...
rootsToAdd
:
string
[]
,
)
:
Promise
<
void
>
Parameters
start
:
number
Optional
deleteCount
:
number
...
rootsToAdd
:
string
[]
Returns
Promise
<
void
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
$find
Text
In
Files
$get
Canonical
Uri
$get
Valid
Encoding
$get
Workspace
$on
Text
Document
Content
Change
$pick
Workspace
Folder
$register
Canonical
Uri
Provider
$register
Text
Document
Content
Provider
$request
Workspace
Trust
$resolve
Decoding
$resolve
Encoding
$resolve
Proxy
$start
File
Search
$unregister
Canonical
Uri
Provider
$unregister
Text
Document
Content
Provider
$update
Workspace
Folders
Eclipse Theia Website
GitHub
Theia API Documentation v1.65.0
Loading...