Class WorkspaceExtImpl

Implements

WorkspaceExt

Index

Constructors

Properties

_trusted? canonicalUriProviders didGrantWorkspaceTrustEmitter documentContentProviders editorsAndDocuments folders messageService onDidChangeWorkspaceFolders onDidGrantWorkspaceTrust proxy rpc searchInWorkspaceEmitter workspaceFileUri workspaceFoldersChangedEmitter workspaceSearchSequence

Accessors

name rootPath trusted workspaceFile workspaceFolders

Constructors

constructor

new WorkspaceExtImpl(): WorkspaceExtImpl
Returns WorkspaceExtImpl

Properties

`Private` `Optional` _trusted

_trusted?: boolean = undefined

`Private` canonicalUriProviders

canonicalUriProviders: Map<string, CanonicalUriProvider> = ...

`Private` didGrantWorkspaceTrustEmitter

didGrantWorkspaceTrustEmitter: Emitter<void> = ...

`Private` documentContentProviders

documentContentProviders: Map<string, TextDocumentContentProvider> = ...

`Protected` editorsAndDocuments

editorsAndDocuments: EditorsAndDocumentsExtImpl

`Private` folders

folders: undefined | WorkspaceFolder[]

`Protected` messageService

messageService: MessageRegistryExt

`Readonly` onDidChangeWorkspaceFolders

onDidChangeWorkspaceFolders: Event<WorkspaceFoldersChangeEvent> = ...

`Readonly` onDidGrantWorkspaceTrust

onDidGrantWorkspaceTrust: Event<void> = ...

`Private` proxy

proxy: WorkspaceMain

`Protected` `Readonly` rpc

rpc: RPCProtocol

`Private` searchInWorkspaceEmitter

searchInWorkspaceEmitter: Emitter<{
result?: TextSearchResult;
searchId: number;
}> = ...

Type declaration

Optional result?: TextSearchResult
searchId: number

`Private` workspaceFileUri

workspaceFileUri: undefined | Uri

`Private` workspaceFoldersChangedEmitter

workspaceFoldersChangedEmitter: Emitter<WorkspaceFoldersChangeEvent> = ...

`Protected` workspaceSearchSequence

workspaceSearchSequence: number = 0

Accessors

name

get name(): undefined | string
Returns undefined | string
- Defined in packages/plugin-ext/src/plugin/workspace.ts:98

rootPath

get rootPath(): undefined | string
Returns undefined | string
- Defined in packages/plugin-ext/src/plugin/workspace.ts:82

trusted

get trusted(): boolean
Returns boolean
- Defined in packages/plugin-ext/src/plugin/workspace.ts:447

workspaceFile

get workspaceFile(): undefined | Uri
Returns undefined | Uri
- Defined in packages/plugin-ext/src/plugin/workspace.ts:94

workspaceFolders

get workspaceFolders(): undefined | WorkspaceFolder[]
Returns undefined | WorkspaceFolder[]
- Defined in packages/plugin-ext/src/plugin/workspace.ts:87

Methods

$disposeCanonicalUriProvider

$disposeCanonicalUriProvider(scheme): void
Parameters
- scheme: string
Returns void
Implementation of WorkspaceExt.$disposeCanonicalUriProvider
- Defined in packages/plugin-ext/src/plugin/workspace.ts:479

$onTextSearchResult

$onTextSearchResult(searchRequestId, done, result?): void
Parameters
- searchRequestId: number
- done: boolean
- Optional result: SearchInWorkspaceResult
Returns void
Implementation of WorkspaceExt.$onTextSearchResult
- Defined in packages/plugin-ext/src/plugin/workspace.ts:126

$onWorkspaceFoldersChanged

$onWorkspaceFoldersChanged(event): void
Parameters
- event: WorkspaceRootsChangeEvent
Returns void
Implementation of WorkspaceExt.$onWorkspaceFoldersChanged
- Defined in packages/plugin-ext/src/plugin/workspace.ts:110

$onWorkspaceLocationChanged

$onWorkspaceLocationChanged(stat): void
Parameters
- stat: undefined | FileStat
Returns void
Implementation of WorkspaceExt.$onWorkspaceLocationChanged
- Defined in packages/plugin-ext/src/plugin/workspace.ts:122

$onWorkspaceTrustChanged

$onWorkspaceTrustChanged(trust): void
Parameters
- trust: undefined | boolean
Returns void
Implementation of WorkspaceExt.$onWorkspaceTrustChanged
- Defined in packages/plugin-ext/src/plugin/workspace.ts:458

$provideCanonicalUri

$provideCanonicalUri(uri, targetScheme, token): Promise<undefined | string>
Parameters
- uri: string
- targetScheme: string
- token: CancellationToken
Returns Promise<undefined | string>
Implementation of WorkspaceExt.$provideCanonicalUri
- Defined in packages/plugin-ext/src/plugin/workspace.ts:490

$provideTextDocumentContent

$provideTextDocumentContent(documentURI): Promise<undefined | null | string>
Parameters
- documentURI: string
Returns Promise<undefined | null | string>
Implementation of WorkspaceExt.$provideTextDocumentContent
- Defined in packages/plugin-ext/src/plugin/workspace.ts:300

$registerEditSessionIdentityProvider

$registerEditSessionIdentityProvider(scheme, provider): Disposable
Parameters
- scheme: string
- provider: EditSessionIdentityProvider
Returns Disposable
Stubbed
Implementation of WorkspaceExt.$registerEditSessionIdentityProvider
- Defined in packages/plugin-ext/src/plugin/workspace.ts:502

`Private` deltaFolders

deltaFolders(currentFolders?, newFolders?): {
added: WorkspaceFolder[];
removed: WorkspaceFolder[];
}
Parameters
- currentFolders: WorkspaceFolder[] = []
- newFolders: WorkspaceFolder[] = []
Returns {
added: WorkspaceFolder[];
removed: WorkspaceFolder[];
}
- added: WorkspaceFolder[]
- removed: WorkspaceFolder[]
- Defined in packages/plugin-ext/src/plugin/workspace.ts:151

findFiles

findFiles(include, exclude?, maxResults?, token?): PromiseLike<URI[]>
Parameters
- include: GlobPattern
- Optional exclude: null | GlobPattern
- Optional maxResults: number
- token: CancellationToken = CancellationToken.None
Returns PromiseLike<URI[]>
- Defined in packages/plugin-ext/src/plugin/workspace.ts:191

findTextInFiles

findTextInFiles(query, optionsOrCallback, callbackOrToken?, token?): Promise<TextSearchComplete>
Parameters
- query: TextSearchQuery
- optionsOrCallback: FindTextInFilesOptions | ((result) => void)
- Optional callbackOrToken: CancellationToken | ((result) => void)
- Optional token: CancellationToken
Returns Promise<TextSearchComplete>
- Defined in packages/plugin-ext/src/plugin/workspace.ts:227

`Private` foldersDiff

foldersDiff(folder1?, folder2?): WorkspaceFolder[]
Parameters
- folder1: WorkspaceFolder[] = []
- folder2: WorkspaceFolder[] = []
Returns WorkspaceFolder[]
- Defined in packages/plugin-ext/src/plugin/workspace.ts:160

getCanonicalUri

getCanonicalUri(uri, options, token): Promise<undefined | Uri>
Parameters
- uri: Uri
- options: CanonicalUriRequestOptions
- token: CancellationToken
Returns Promise<undefined | Uri>
Implementation of WorkspaceExt.getCanonicalUri
- Defined in packages/plugin-ext/src/plugin/workspace.ts:485

getRelativePath

getRelativePath(pathOrUri, includeWorkspace?): undefined | string
Parameters
- pathOrUri: string | Uri
- Optional includeWorkspace: boolean
Returns undefined | string
- Defined in packages/plugin-ext/src/plugin/workspace.ts:355

getWorkspaceFolder

getWorkspaceFolder(uri, resolveParent?): undefined | WorkspaceFolder
Parameters
- uri: Uri
- Optional resolveParent: boolean
Returns undefined | WorkspaceFolder
- Defined in packages/plugin-ext/src/plugin/workspace.ts:310

`Private` hasFolder

hasFolder(uri): boolean
Parameters
- uri: URI
Returns boolean
- Defined in packages/plugin-ext/src/plugin/workspace.ts:348

initialize

initialize(): void
Returns void
- Defined in packages/plugin-ext/src/plugin/workspace.ts:78

pickWorkspaceFolder

pickWorkspaceFolder(options?): PromiseLike<undefined | WorkspaceFolder>
Parameters
- Optional options: WorkspaceFolderPickOptions
Returns PromiseLike<undefined | WorkspaceFolder>
- Defined in packages/plugin-ext/src/plugin/workspace.ts:178

`Private` refreshWorkspaceFile

refreshWorkspaceFile(): Promise<void>
Returns Promise<void>
- Defined in packages/plugin-ext/src/plugin/workspace.ts:435

registerCanonicalUriProvider

registerCanonicalUriProvider(scheme, provider): Disposable
Parameters
- scheme: string
- provider: CanonicalUriProvider
Returns Disposable
Implementation of WorkspaceExt.registerCanonicalUriProvider
- Defined in packages/plugin-ext/src/plugin/workspace.ts:465

registerTextDocumentContentProvider

registerTextDocumentContentProvider(scheme, provider): Disposable
Parameters
- scheme: string
- provider: TextDocumentContentProvider
Returns Disposable
- Defined in packages/plugin-ext/src/plugin/workspace.ts:259

requestWorkspaceTrust

requestWorkspaceTrust(options?): Promise<undefined | boolean>
Parameters
- Optional options: WorkspaceTrustRequestOptions
Returns Promise<undefined | boolean>
- Defined in packages/plugin-ext/src/plugin/workspace.ts:454

resolveProxy

resolveProxy(url): Promise<undefined | string>
Parameters
- url: string
Returns Promise<undefined | string>
- Defined in packages/plugin-ext/src/plugin/workspace.ts:106

`Private` toWorkspaceFolder

toWorkspaceFolder(root, index): WorkspaceFolder
Parameters
- root: string
- index: number
Returns WorkspaceFolder
- Defined in packages/plugin-ext/src/plugin/workspace.ts:168

`Private` updateWorkSpace

updateWorkSpace(workspace): void
Parameters
- workspace: undefined | FileStat
Returns void
- Defined in packages/plugin-ext/src/plugin/workspace.ts:440

updateWorkspaceFolders

updateWorkspaceFolders(start, deleteCount, ...workspaceFoldersToAdd): boolean
Parameters
- start: number
- deleteCount: number
- Rest ...workspaceFoldersToAdd: {
  name?: string;
  uri: Uri;
  }[]
Returns boolean
- Defined in packages/plugin-ext/src/plugin/workspace.ts:387

Class WorkspaceExtImpl

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns WorkspaceExtImpl

Properties

Private Optional _trusted

Private canonicalUriProviders

Private didGrantWorkspaceTrustEmitter

Private documentContentProviders

Protected editorsAndDocuments

Private folders

Protected messageService

Readonly onDidChangeWorkspaceFolders

Readonly onDidGrantWorkspaceTrust

Private proxy

Protected Readonly rpc

Private searchInWorkspaceEmitter

Type declaration

Optional result?: TextSearchResult

searchId: number

Private workspaceFileUri

Private workspaceFoldersChangedEmitter

Protected workspaceSearchSequence

Accessors

name

Returns undefined | string

rootPath

Returns undefined | string

trusted

Returns boolean

workspaceFile

Returns undefined | Uri

workspaceFolders

Returns undefined | WorkspaceFolder[]

Methods

$disposeCanonicalUriProvider

Parameters

Returns void

$onTextSearchResult

Parameters

Returns void

$onWorkspaceFoldersChanged

Parameters

Returns void

$onWorkspaceLocationChanged

Parameters

Returns void

$onWorkspaceTrustChanged

Parameters

Returns void

$provideCanonicalUri

Parameters

Returns Promise<undefined | string>

$provideTextDocumentContent

Parameters

Returns Promise<undefined | null | string>

$registerEditSessionIdentityProvider

Parameters

Returns Disposable

Stubbed

Private deltaFolders

Parameters

Returns { added: WorkspaceFolder[]; removed: WorkspaceFolder[]; }

added: WorkspaceFolder[]

removed: WorkspaceFolder[]

findFiles

Parameters

Returns PromiseLike<URI[]>

findTextInFiles

Parameters

Returns Promise<TextSearchComplete>

Private foldersDiff

Parameters

Returns WorkspaceFolder[]

`Private` `Optional` _trusted

`Private` canonicalUriProviders

`Private` didGrantWorkspaceTrustEmitter

`Private` documentContentProviders

`Protected` editorsAndDocuments

`Private` folders

`Protected` messageService

`Readonly` onDidChangeWorkspaceFolders

`Readonly` onDidGrantWorkspaceTrust

`Private` proxy

`Protected` `Readonly` rpc

`Private` searchInWorkspaceEmitter

`Optional` result?: TextSearchResult

`Private` workspaceFileUri

`Private` workspaceFoldersChangedEmitter

`Protected` workspaceSearchSequence

`Private` deltaFolders

Returns {
added: WorkspaceFolder[];
removed: WorkspaceFolder[];
}

`Private` foldersDiff

`Private` hasFolder

`Private` refreshWorkspaceFile

`Private` toWorkspaceFolder

`Private` updateWorkSpace