Class WorkspaceTrustService

Index

Constructors

Properties

contextKeyService currentTrust envVariablesServer messageService onDidChangeWorkspaceTrust onDidChangeWorkspaceTrustEmitter pendingTrustDialog pendingTrustRequest preferences preferenceSchemaService restrictionContributions statusBar storage toDispose untitledWorkspaceService windowService workspaceService workspaceTrust workspaceTrustPref

Constructors

constructor

new WorkspaceTrustService(): WorkspaceTrustService
Returns WorkspaceTrustService

Properties

`Protected` `Readonly`contextKeyService

contextKeyService: ContextKeyService

`Protected`currentTrust

currentTrust: undefined | boolean

`Protected` `Readonly`envVariablesServer

envVariablesServer: EnvVariablesServer

`Protected` `Readonly`messageService

messageService: MessageService

`Readonly`onDidChangeWorkspaceTrust

onDidChangeWorkspaceTrust: Event<boolean> = ...

`Protected` `Readonly`onDidChangeWorkspaceTrustEmitter

onDidChangeWorkspaceTrustEmitter: Emitter<boolean> = ...

`Protected`pendingTrustDialog

pendingTrustDialog: undefined | Deferred<boolean>

`Protected`pendingTrustRequest

pendingTrustRequest: undefined | Deferred<undefined | boolean>

`Protected` `Readonly`preferences

preferences: PreferenceService

`Protected` `Readonly`preferenceSchemaService

preferenceSchemaService: PreferenceSchemaService

`Protected` `Readonly`restrictionContributions

restrictionContributions: ContributionProvider<WorkspaceRestrictionContribution>

`Protected` `Readonly`statusBar

statusBar: StatusBar

`Protected` `Readonly`storage

storage: StorageService

`Protected` `Readonly`toDispose

toDispose: DisposableCollection = ...

`Protected` `Readonly`untitledWorkspaceService

untitledWorkspaceService: UntitledWorkspaceService

`Protected` `Readonly`windowService

windowService: WindowService

`Protected` `Readonly`workspaceService

workspaceService: WorkspaceService

`Protected`workspaceTrust

workspaceTrust: Deferred<boolean> = ...

`Protected` `Readonly`workspaceTrustPref

workspaceTrustPref: WorkspaceTrustPreferences

Methods

addToTrustedFolders

addToTrustedFolders(): Promise<void>
Returns Promise<void>
- Defined in packages/workspace/src/browser/workspace-trust-service.ts:312

`Protected`areAllWorkspaceUrisTrusted

areAllWorkspaceUrisTrusted(): Promise<boolean>
Check if all workspace URIs are trusted. A workspace is trusted only if ALL of its folders (and the workspace file for saved workspaces) are trusted.

Returns Promise<boolean>
- Defined in packages/workspace/src/browser/workspace-trust-service.ts:259

`Protected`calculateWorkspaceTrust

calculateWorkspaceTrust(): Promise<undefined | boolean>
Returns Promise<undefined | boolean>
- Defined in packages/workspace/src/browser/workspace-trust-service.ts:185

`Protected`collectRestrictions

collectRestrictions(): WorkspaceRestriction[]
Returns WorkspaceRestriction[]
- Defined in packages/workspace/src/browser/workspace-trust-service.ts:491

`Protected`confirmRestart

confirmRestart(): Promise<boolean>
Returns Promise<boolean>
- Defined in packages/workspace/src/browser/workspace-trust-service.ts:430

`Protected`createRestrictedModeTooltip

createRestrictedModeTooltip(): MarkdownString
Returns MarkdownString
- Defined in packages/workspace/src/browser/workspace-trust-service.ts:460

`Protected`doInit

doInit(): Promise<void>
Returns Promise<void>
- Defined in packages/workspace/src/browser/workspace-trust-service.ts:116

getWorkspaceTrust

getWorkspaceTrust(): Promise<boolean>
Returns Promise<boolean>
- Defined in packages/workspace/src/browser/workspace-trust-service.ts:145

`Protected`getWorkspaceUris

getWorkspaceUris(): URI[]
Get the URIs that need to be trusted for the current workspace. This includes all workspace folder URIs, plus the workspace file URI for saved workspaces (since workspace files can contain tasks/settings).

Returns URI[]
- Defined in packages/workspace/src/browser/workspace-trust-service.ts:244

`Protected`handlePreferenceChange

handlePreferenceChange(change: PreferenceChange): Promise<void>
Parameters
- change: PreferenceChange
Returns Promise<void>
- Defined in packages/workspace/src/browser/workspace-trust-service.ts:379

`Protected`handleWorkspaceChanged

handleWorkspaceChanged(): Promise<void>
Returns Promise<void>
- Defined in packages/workspace/src/browser/workspace-trust-service.ts:417

`Protected`hideRestrictedModeStatusBarItem

hideRestrictedModeStatusBarItem(): void
Returns void
- Defined in packages/workspace/src/browser/workspace-trust-service.ts:499

`Protected`init

init(): void
Returns void
- Defined in packages/workspace/src/browser/workspace-trust-service.ts:112

`Protected`isEmptyWorkspace

isEmptyWorkspace(): Promise<boolean>
Check if the workspace is empty (no workspace or folder opened, or an untitled workspace with no folders). A saved workspace file with 0 folders is NOT empty - it still needs trust evaluation because it could have tasks defined.

Returns Promise<boolean>
- Defined in packages/workspace/src/browser/workspace-trust-service.ts:222

`Protected`isUriTrusted

isUriTrusted(uri: URI): boolean
Check if a URI is trusted. A URI is trusted if it or any of its parent folders is in the trusted folders list.
Parameters
- uri: URI
Returns boolean
- Defined in packages/workspace/src/browser/workspace-trust-service.ts:271

`Protected`isWorkspaceTrustResolved

isWorkspaceTrustResolved(): boolean
Returns boolean
- Defined in packages/workspace/src/browser/workspace-trust-service.ts:181

`Protected`loadWorkspaceTrust

loadWorkspaceTrust(): Promise<undefined | boolean>
Returns Promise<undefined | boolean>
- Defined in packages/workspace/src/browser/workspace-trust-service.ts:367

`Protected`onStop

onStop(): void
Returns void
- Defined in packages/workspace/src/browser/workspace-trust-service.ts:141

refreshRestrictedModeIndicator

refreshRestrictedModeIndicator(): void
Refreshes the restricted mode status bar item. Call this when restriction contributions change.

Returns void
- Defined in packages/workspace/src/browser/workspace-trust-service.ts:507

removeFromTrustedFolders

removeFromTrustedFolders(): Promise<void>
Returns Promise<void>
- Defined in packages/workspace/src/browser/workspace-trust-service.ts:338

requestWorkspaceTrust

requestWorkspaceTrust(): Promise<undefined | boolean>
Request workspace trust from the user. This method follows VS Code's pattern:
- If already trusted, returns true immediately
- If there's already a pending trust request, returns the same promise (avoiding duplicate dialogs)
- Otherwise, shows a dialog and waits for the user's response
Unlike the initial trust resolution, this can be called multiple times and will prompt the user each time (unless a dialog is already open).
Returns Promise<undefined | boolean>
- Defined in packages/workspace/src/browser/workspace-trust-service.ts:522

`Protected`resolveWorkspaceTrust

resolveWorkspaceTrust(givenTrust?: boolean): Promise<void>
Parameters
- OptionalgivenTrust: boolean
Returns Promise<void>
- Defined in packages/workspace/src/browser/workspace-trust-service.ts:153

setWorkspaceTrust

setWorkspaceTrust(trusted: boolean): void
Parameters
- trusted: boolean
Returns void
- Defined in packages/workspace/src/browser/workspace-trust-service.ts:169

`Protected`showRestrictedModeStatusBarItem

showRestrictedModeStatusBarItem(): void
Returns void
- Defined in packages/workspace/src/browser/workspace-trust-service.ts:448

`Protected`showTrustPromptDialog

showTrustPromptDialog(): Promise<boolean>
Returns Promise<boolean>
- Defined in packages/workspace/src/browser/workspace-trust-service.ts:287

`Protected`storeWorkspaceTrust

storeWorkspaceTrust(trust: boolean): Promise<void>
Parameters
- trust: boolean
Returns Promise<void>
- Defined in packages/workspace/src/browser/workspace-trust-service.ts:373

`Protected`updateRestrictedModeIndicator

updateRestrictedModeIndicator(trusted: boolean): void
Parameters
- trusted: boolean
Returns void
- Defined in packages/workspace/src/browser/workspace-trust-service.ts:440