Class WorkspaceExtImpl

Implements

WorkspaceExt

Index

Constructors

Properties

_trusted? canonicalUriProviders didGrantWorkspaceTrustEmitter documentContentProviders editorsAndDocuments encodingService folders logger 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

`Protected` encodingService

encodingService: EncodingService

`Private` folders

folders: undefined | WorkspaceFolder[]

`Private` logger

logger: PluginLogger

`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:107

rootPath

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

trusted

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

workspaceFile

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

workspaceFolders

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

Methods

$disposeCanonicalUriProvider

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

$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:135

$onWorkspaceFoldersChanged

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

$onWorkspaceLocationChanged

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

$onWorkspaceTrustChanged

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

$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:502

$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:312

$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:514

`Private` asEncodeDecodeParameters

asEncodeDecodeParameters(opts?): [undefined | UriComponents, undefined | {
encoding: string;
}]
Parameters
- Optional opts: {
  encoding?: string;
  uri?: Uri;
  }
  - Optional encoding?: string
  - Optional uri?: Uri
Returns [undefined | UriComponents, undefined | {
encoding: string;
}]
- Defined in packages/plugin-ext/src/plugin/workspace.ts:543

decode

decode(content, args?): Promise<string>
Parameters
- content: Uint8Array
- Optional args: {
  encoding?: string;
  uri?: Uri;
  }
  - Optional encoding?: string
  - Optional uri?: Uri
Returns Promise<string>
- Defined in packages/plugin-ext/src/plugin/workspace.ts:518

`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:160

encode

encode(content, args?): Promise<Uint8Array>
Parameters
- content: string
- Optional args: {
  encoding?: string;
  uri?: Uri;
  }
  - Optional encoding?: string
  - Optional uri?: Uri
Returns Promise<Uint8Array>
- Defined in packages/plugin-ext/src/plugin/workspace.ts:536

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:200

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:239

`Private` foldersDiff

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

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:497

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:367

getWorkspaceFolder

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

`Private` hasFolder

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

initialize

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

pickWorkspaceFolder

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

`Private` refreshWorkspaceFile

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

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:477

registerTextDocumentContentProvider

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

requestWorkspaceTrust

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

resolveProxy

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

`Private` toWorkspaceFolder

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

`Private` updateWorkSpace

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

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:399

Class WorkspaceExtImpl

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns WorkspaceExtImpl

Properties

Private Optional _trusted

Private canonicalUriProviders

Private didGrantWorkspaceTrustEmitter

Private documentContentProviders

Protected editorsAndDocuments

Protected encodingService

Private folders

Private logger

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 asEncodeDecodeParameters

Parameters

Optional encoding?: string

Optional uri?: Uri

Returns [undefined | UriComponents, undefined | { encoding: string; }]

decode

Parameters

Optional encoding?: string

Optional uri?: Uri

Returns Promise<string>

Private deltaFolders

Parameters

`Private` `Optional` _trusted

`Private` canonicalUriProviders

`Private` didGrantWorkspaceTrustEmitter

`Private` documentContentProviders

`Protected` editorsAndDocuments

`Protected` encodingService

`Private` folders

`Private` logger

`Protected` messageService

`Readonly` onDidChangeWorkspaceFolders

`Readonly` onDidGrantWorkspaceTrust

`Private` proxy

`Protected` `Readonly` rpc

`Private` searchInWorkspaceEmitter

`Optional` result?: TextSearchResult

`Private` workspaceFileUri

`Private` workspaceFoldersChangedEmitter

`Protected` workspaceSearchSequence

`Private` asEncodeDecodeParameters

`Optional` encoding?: string

`Optional` uri?: Uri

Returns [undefined | UriComponents, undefined | {
encoding: string;
}]

`Optional` encoding?: string

`Optional` uri?: Uri

`Private` deltaFolders

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

`Optional` encoding?: string

`Optional` uri?: Uri

`Private` foldersDiff

`Private` hasFolder

`Private` refreshWorkspaceFile

`Private` toWorkspaceFolder

`Private` updateWorkSpace