Class WorkspaceMainImpl

Implements

Constructors

constructor

new WorkspaceMainImpl(rpc: RPCProtocol, container: Container): WorkspaceMainImpl
Parameters
- rpc: RPCProtocol
- container: Container
Returns WorkspaceMainImpl
- Defined in packages/plugin-ext/src/main/browser/workspace-main.ts:81

Properties

`Protected` `Readonly`canonicalUriProviders

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

`Protected` `Readonly`canonicalUriService

canonicalUriService: CanonicalUriService

`Protected` `Readonly`toDispose

toDispose: DisposableCollection = ...

`Protected`workspaceSearch

workspaceSearch: Set<number> = ...

Methods

$findTextInFiles

$findTextInFiles(
    query: TextSearchQuery,
    options: FindTextInFilesOptions,
    searchRequestId: number,
    token?: CancellationToken,
): Promise<TextSearchComplete>
Parameters
- query: TextSearchQuery
- options: FindTextInFilesOptions
- searchRequestId: number
- token: CancellationToken = CancellationToken.None
Returns Promise<TextSearchComplete>
Implementation of WorkspaceMain.$findTextInFiles
- Defined in packages/plugin-ext/src/main/browser/workspace-main.ts:224

$getCanonicalUri

$getCanonicalUri(
    uri: string,
    targetScheme: string,
    token: CancellationToken,
): Promise<undefined | string>
Parameters
- uri: string
- targetScheme: string
- token: CancellationToken
Returns Promise<undefined | string>
Implementation of WorkspaceMain.$getCanonicalUri
- Defined in packages/plugin-ext/src/main/browser/workspace-main.ts:330

$getValidEncoding

$getValidEncoding(
    uri: undefined | UriComponents,
    detectedEncoding: undefined | string,
    options: undefined | { encoding: string },
): Promise<string>
Parameters
- uri: undefined | UriComponents
- detectedEncoding: undefined | string
- options: undefined | { encoding: string }
Returns Promise<string>
Implementation of WorkspaceMain.$getValidEncoding
- Defined in packages/plugin-ext/src/main/browser/workspace-main.ts:357

$getWorkspace

$getWorkspace(): Promise<undefined | FileStat>
Returns Promise<undefined | FileStat>
Implementation of WorkspaceMain.$getWorkspace
- Defined in packages/plugin-ext/src/main/browser/workspace-main.ts:139

$onTextDocumentContentChange

$onTextDocumentContentChange(uri: string, content: string): void
Parameters
- uri: string
- content: string
Returns void
Implementation of WorkspaceMain.$onTextDocumentContentChange
- Defined in packages/plugin-ext/src/main/browser/workspace-main.ts:295

$pickWorkspaceFolder

$pickWorkspaceFolder(
options: WorkspaceFolderPickOptionsMain,
): Promise<undefined | WorkspaceFolder>
Parameters
- options: WorkspaceFolderPickOptionsMain
Returns Promise<undefined | WorkspaceFolder>
Implementation of WorkspaceMain.$pickWorkspaceFolder
- Defined in packages/plugin-ext/src/main/browser/workspace-main.ts:143

$registerCanonicalUriProvider

$registerCanonicalUriProvider(scheme: string): Promise<undefined | void>
Parameters
- scheme: string
Returns Promise<undefined | void>
Implementation of WorkspaceMain.$registerCanonicalUriProvider
- Defined in packages/plugin-ext/src/main/browser/workspace-main.ts:307

$registerTextDocumentContentProvider

$registerTextDocumentContentProvider(scheme: string): Promise<void>
Parameters
- scheme: string
Returns Promise<void>
Implementation of WorkspaceMain.$registerTextDocumentContentProvider
- Defined in packages/plugin-ext/src/main/browser/workspace-main.ts:286

$requestWorkspaceTrust

$requestWorkspaceTrust(
_options?: WorkspaceTrustRequestOptions,
): Promise<undefined | boolean>
Parameters
- Optional_options: WorkspaceTrustRequestOptions
Returns Promise<undefined | boolean>
Implementation of WorkspaceMain.$requestWorkspaceTrust
- Defined in packages/plugin-ext/src/main/browser/workspace-main.ts:303

$resolveDecoding

$resolveDecoding(
resource: undefined | UriComponents,
options?: { encoding?: string },
): Promise<{ guessEncoding: boolean; preferredEncoding: string }>
Parameters
- resource: undefined | UriComponents
- Optionaloptions: { encoding?: string }
Returns Promise<{ guessEncoding: boolean; preferredEncoding: string }>
Implementation of WorkspaceMain.$resolveDecoding
- Defined in packages/plugin-ext/src/main/browser/workspace-main.ts:335

$resolveEncoding

$resolveEncoding(
resource: undefined | UriComponents,
options?: { encoding?: string },
): Promise<{ encoding: string; hasBOM: boolean }>
Parameters
- resource: undefined | UriComponents
- Optionaloptions: { encoding?: string }
Returns Promise<{ encoding: string; hasBOM: boolean }>
Implementation of WorkspaceMain.$resolveEncoding
- Defined in packages/plugin-ext/src/main/browser/workspace-main.ts:344

$resolveProxy

$resolveProxy(url: string): Promise<undefined | string>
Parameters
- url: string
Returns Promise<undefined | string>
Implementation of WorkspaceMain.$resolveProxy
- Defined in packages/plugin-ext/src/main/browser/workspace-main.ts:112

$startFileSearch

$startFileSearch(
    includePattern: string,
    includeFolderUri: undefined | string,
    options: FindFilesOptions,
): Promise<UriComponents[]>
Parameters
- includePattern: string
- includeFolderUri: undefined | string
- options: FindFilesOptions
Returns Promise<UriComponents[]>
Implementation of WorkspaceMain.$startFileSearch
- Defined in packages/plugin-ext/src/main/browser/workspace-main.ts:185

$unregisterCanonicalUriProvider

$unregisterCanonicalUriProvider(scheme: string): void
Parameters
- scheme: string
Returns void
Implementation of WorkspaceMain.$unregisterCanonicalUriProvider
- Defined in packages/plugin-ext/src/main/browser/workspace-main.ts:320

$unregisterTextDocumentContentProvider

$unregisterTextDocumentContentProvider(scheme: string): void
Parameters
- scheme: string
Returns void
Implementation of WorkspaceMain.$unregisterTextDocumentContentProvider
- Defined in packages/plugin-ext/src/main/browser/workspace-main.ts:291

$updateWorkspaceFolders

$updateWorkspaceFolders(
    start: number,
    deleteCount?: number,
    ...rootsToAdd: string[],
): Promise<void>
Parameters
- start: number
- OptionaldeleteCount: number
- ...rootsToAdd: string[]
Returns Promise<void>
Implementation of WorkspaceMain.$updateWorkspaceFolders
- Defined in packages/plugin-ext/src/main/browser/workspace-main.ts:299

dispose

dispose(): void
Dispose this object.

Returns void
Implementation of Disposable.dispose
- Defined in packages/plugin-ext/src/main/browser/workspace-main.ts:108

getPreferredReadEncoding

getPreferredReadEncoding(
    uri: undefined | UriComponents,
    options?: { encoding?: string },
    detectedEncoding?: string,
): Promise<string>
Parameters
- uri: undefined | UriComponents
- Optionaloptions: { encoding?: string }
- OptionaldetectedEncoding: string
Returns Promise<string>
- Defined in packages/plugin-ext/src/main/browser/workspace-main.ts:361

`Protected`processWorkspaceFoldersChanged

processWorkspaceFoldersChanged(roots: string[]): Promise<void>
Parameters
- roots: string[]
Returns Promise<void>
- Defined in packages/plugin-ext/src/main/browser/workspace-main.ts:116

Class WorkspaceMainImpl

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns WorkspaceMainImpl

Properties

Protected ReadonlycanonicalUriProviders

Protected ReadonlycanonicalUriService

Protected ReadonlytoDispose

ProtectedworkspaceSearch

Methods

$findTextInFiles

Parameters

Returns Promise<TextSearchComplete>

$getCanonicalUri

Parameters

Returns Promise<undefined | string>

$getValidEncoding

Parameters

Returns Promise<string>

$getWorkspace

Returns Promise<undefined | FileStat>

$onTextDocumentContentChange

Parameters

Returns void

$pickWorkspaceFolder

Parameters

Returns Promise<undefined | WorkspaceFolder>

$registerCanonicalUriProvider

Parameters

Returns Promise<undefined | void>

$registerTextDocumentContentProvider

Parameters

Returns Promise<void>

$requestWorkspaceTrust

Parameters

Returns Promise<undefined | boolean>

$resolveDecoding

Parameters

Returns Promise<{ guessEncoding: boolean; preferredEncoding: string }>

$resolveEncoding

Parameters

Returns Promise<{ encoding: string; hasBOM: boolean }>

$resolveProxy

Parameters

Returns Promise<undefined | string>

$startFileSearch

Parameters

Returns Promise<UriComponents[]>

$unregisterCanonicalUriProvider

Parameters

Returns void

$unregisterTextDocumentContentProvider

Parameters

Returns void

$updateWorkspaceFolders

Parameters

Returns Promise<void>

dispose

Returns void

getPreferredReadEncoding

Parameters

Returns Promise<string>

ProtectedprocessWorkspaceFoldersChanged

Parameters

Returns Promise<void>

Settings

On This Page

`Protected` `Readonly`canonicalUriProviders

`Protected` `Readonly`canonicalUriService

`Protected` `Readonly`toDispose

`Protected`workspaceSearch

`Protected`processWorkspaceFoldersChanged