Class WorkspaceMainImpl

Implements

WorkspaceMain
Disposable

Constructors

constructor

new WorkspaceMainImpl(rpc, 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

`Private` encodingRegistry

encodingRegistry: EncodingRegistry

`Private` fileSearchService

fileSearchService: FileSearchService

`Private` fsPreferences

fsPreferences: FileSystemPreferences

`Private` monacoQuickInputService

monacoQuickInputService: MonacoQuickInputService

`Private` pluginServer

pluginServer: PluginServer

`Private` preferenceService

preferenceService: PreferenceService

`Private` `Readonly` proxy

proxy: WorkspaceExt

`Private` requestService

requestService: RequestService

`Private` resourceResolver

resourceResolver: TextContentResourceResolver

`Private` roots

roots: string[]

`Private` searchInWorkspaceService

searchInWorkspaceService: SearchInWorkspaceService

`Private` storageProxy

storageProxy: StorageExt

`Protected` `Readonly` toDispose

toDispose: DisposableCollection = ...

`Protected` workspaceSearch

workspaceSearch: Set<number> = ...

`Private` workspaceService

workspaceService: WorkspaceService

`Private` workspaceTrustService

workspaceTrustService: WorkspaceTrustService

Methods

$findTextInFiles

$findTextInFiles(query, options, searchRequestId, token?): 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, targetScheme, token): 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, detectedEncoding, options): 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, content): 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): 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): 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): 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?): 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, options?): Promise<{
guessEncoding: boolean;
preferredEncoding: string;
}>
Parameters
- resource: undefined | UriComponents
- Optional options: {
  encoding?: string;
  }
  - Optional 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, options?): Promise<{
encoding: string;
hasBOM: boolean;
}>
Parameters
- resource: undefined | UriComponents
- Optional options: {
  encoding?: string;
  }
  - Optional 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): 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, includeFolderUri, options): 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): 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): 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, deleteCount?, ...rootsToAdd): Promise<void>
Parameters
- start: number
- Optional deleteCount: number
- Rest ...rootsToAdd: string[]
Returns Promise<void>
Implementation of WorkspaceMain.$updateWorkspaceFolders
- Defined in packages/plugin-ext/src/main/browser/workspace-main.ts:299

dispose

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

getPreferredReadEncoding

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

`Private` isAnyRootChanged

isAnyRootChanged(roots): boolean
Parameters
- roots: string[]
Returns boolean
- Defined in packages/plugin-ext/src/main/browser/workspace-main.ts:131

`Protected` processWorkspaceFoldersChanged

processWorkspaceFoldersChanged(roots): 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 Readonly canonicalUriProviders

Protected Readonly canonicalUriService

Private encodingRegistry

Private fileSearchService

Private fsPreferences

Private monacoQuickInputService

Private pluginServer

Private preferenceService

Private Readonly proxy

Private requestService

Private resourceResolver

Private roots

Private searchInWorkspaceService

Private storageProxy

Protected Readonly toDispose

Protected workspaceSearch

Private workspaceService

Private workspaceTrustService

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

Optional encoding?: string

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

$resolveEncoding

Parameters

Optional encoding?: string

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

`Protected` `Readonly` canonicalUriProviders

`Protected` `Readonly` canonicalUriService

`Private` encodingRegistry

`Private` fileSearchService

`Private` fsPreferences

`Private` monacoQuickInputService

`Private` pluginServer

`Private` preferenceService

`Private` `Readonly` proxy

`Private` requestService

`Private` resourceResolver

`Private` roots

`Private` searchInWorkspaceService

`Private` storageProxy

`Protected` `Readonly` toDispose

`Protected` workspaceSearch

`Private` workspaceService

`Private` workspaceTrustService

`Optional` encoding?: string

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

`Optional` encoding?: string

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

`Optional` encoding?: string

`Private` isAnyRootChanged

`Protected` processWorkspaceFoldersChanged