Class WorkspaceService

The workspace service.

Hierarchy (View Summary)

WorkspaceService
- CollaborationWorkspaceService

Implements

Index

Constructors

constructor

Accessors

isMultiRootWorkspaceOpened onWorkspaceChanged onWorkspaceLocationChanged opened ready roots saved workspace

Constructors

constructor

new WorkspaceService(): WorkspaceService
Returns WorkspaceService

Properties

`Protected`_ready

_ready: Deferred<void> = ...

`Protected`_roots

_roots: FileStat[] = []

`Protected`_workspace

_workspace: undefined | FileStat

`Protected`deferredRoots

deferredRoots: Deferred<FileStat[]> = ...

`Protected` `Readonly`envVariableServer

envVariableServer: EnvVariablesServer

`Protected` `Readonly`fileService

fileService: FileService

`Protected` `Readonly`fsPreferences

fsPreferences: FileSystemPreferences

`Protected` `Readonly`labelProvider

labelProvider: LabelProvider

`Protected`logger

logger: ILogger

`Protected` `Readonly`messageService

messageService: MessageService

`Protected` `Readonly`onWorkspaceChangeEmitter

onWorkspaceChangeEmitter: Emitter<FileStat[]> = ...

`Protected` `Readonly`onWorkspaceLocationChangedEmitter

onWorkspaceLocationChangedEmitter: Emitter<undefined | FileStat> = ...

`Protected` `Readonly`rootWatchers

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

`Protected` `Readonly`schemaService

schemaService: PreferenceSchemaService

`Protected` `Readonly`schemaUpdater

schemaUpdater: WorkspaceSchemaUpdater

`Protected` `Readonly`server

server: WorkspaceServer

`Protected` `Readonly`toDisposeOnWorkspace

toDisposeOnWorkspace: DisposableCollection = ...

`Protected` `Readonly`untitledWorkspaceService

untitledWorkspaceService: UntitledWorkspaceService

`Protected` `Readonly`windowService

windowService: WindowService

`Protected` `Readonly`windowTitleService

windowTitleService: WindowTitleService

`Protected` `Readonly`workspaceFileService

workspaceFileService: WorkspaceFileService

Accessors

isMultiRootWorkspaceOpened

get isMultiRootWorkspaceOpened(): boolean
Returns true if a multiple-root workspace is currently open.

Returns boolean
- Defined in packages/workspace/src/browser/workspace-service.ts:354

onWorkspaceChanged

get onWorkspaceChanged(): Event<FileStat[]>
Returns Event<FileStat[]>
- Defined in packages/workspace/src/browser/workspace-service.ts:197

onWorkspaceLocationChanged

get onWorkspaceLocationChanged(): Event<undefined | FileStat>
Returns Event<undefined | FileStat>
- Defined in packages/workspace/src/browser/workspace-service.ts:202

opened

get opened(): boolean
Returns true if theia has an opened workspace or folder

Returns boolean
- Defined in packages/workspace/src/browser/workspace-service.ts:346

ready

get ready(): Promise<void>
Returns Promise<void>
- Defined in packages/workspace/src/browser/workspace-service.ts:108

roots

get roots(): Promise<FileStat[]>
Returns Promise<FileStat[]>
- Defined in packages/workspace/src/browser/workspace-service.ts:186

saved

get saved(): boolean
true if the current workspace is configured using a configuration file.

false if there is no workspace or the workspace is simply a folder.

Returns boolean
- Defined in packages/workspace/src/browser/workspace-service.ts:583

workspace

get workspace(): undefined | FileStat
Returns undefined | FileStat
- Defined in packages/workspace/src/browser/workspace-service.ts:192

Methods

addRoot

addRoot(uris: URI | URI[]): Promise<void>
Adds root folder(s) to the workspace
Parameters
- uris: URI | URI[]
  URI or URIs of the root folder(s) to add
Returns Promise<void>
- Defined in packages/workspace/src/browser/workspace-service.ts:404

areWorkspaceRoots

areWorkspaceRoots(uris: URI[]): boolean
Parameters
- uris: URI[]
Returns boolean
- Defined in packages/workspace/src/browser/workspace-service.ts:700

canHandle

canHandle(uri: URI): Promise<boolean>
Parameters
- uri: URI
Returns Promise<boolean>
Implementation of WorkspaceOpenHandlerContribution.canHandle
- Defined in packages/workspace/src/browser/workspace-service.ts:375

close

close(): Promise<void>
Clears current workspace root.

Returns Promise<void>
- Defined in packages/workspace/src/browser/workspace-service.ts:484

`Protected`computeRoots

computeRoots(): Promise<FileStat[]>
Returns Promise<FileStat[]>
- Defined in packages/workspace/src/browser/workspace-service.ts:259

containsSome

containsSome(paths: string[]): Promise<boolean>
Return true if one of the paths in paths array is present in the workspace NOTE: You should always explicitly use / as the separator between the path segments.
Parameters
- paths: string[]
Returns Promise<boolean>
- Defined in packages/workspace/src/browser/workspace-service.ts:561

`Protected`doGetDefaultWorkspaceUri

doGetDefaultWorkspaceUri(): Promise<undefined | string>
Returns Promise<undefined | string>
- Defined in packages/workspace/src/browser/workspace-service.ts:149

`Protected`doInit

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

`Protected`doOpen

doOpen(uri: URI, options?: WorkspaceInput): Promise<void>
Parameters
- uri: URI
- Optionaloptions: WorkspaceInput
Returns Promise<void>
- Defined in packages/workspace/src/browser/workspace-service.ts:365

`Protected`getDefaultWorkspaceUri

getDefaultWorkspaceUri(): MaybePromise<undefined | string>
Resolves to the default workspace URI as string.

The default implementation tries to extract the default workspace location from the window.location.hash, then falls-back to the most recently used workspace root from the server.

It is not ensured that the resolved workspace URI is valid, it can point to a non-existing location.

Returns MaybePromise<undefined | string>
- Defined in packages/workspace/src/browser/workspace-service.ts:145

`Protected`getExcludes

getExcludes(uri: string): string[]
Parameters
- uri: string
Returns string[]
- Defined in packages/workspace/src/browser/workspace-service.ts:655

getUntitledWorkspace

getUntitledWorkspace(): Promise<URI>
Returns Promise<URI>
- Defined in packages/workspace/src/browser/workspace-service.ts:458

`Protected`getWorkspaceDataFromFile

getWorkspaceDataFromFile(): Promise<undefined | WorkspaceData>
Returns Promise<undefined | WorkspaceData>
- Defined in packages/workspace/src/browser/workspace-service.ts:281

getWorkspaceRelativePath

getWorkspaceRelativePath(uri: URI): Promise<string>
Returns the relative path of the given file to the workspace root.
Parameters
- uri: URI
  URI of the file
Returns Promise<string>
See
getWorkspaceRootUri(uri)
- Defined in packages/workspace/src/browser/workspace-service.ts:689

getWorkspaceRootUri

getWorkspaceRootUri(uri: undefined | URI): undefined | URI
Returns the workspace root uri that the given file belongs to. In case that the file is found in more than one workspace roots, returns the root that is closest to the file. If the file is not from the current workspace, returns undefined.
Parameters
- uri: undefined | URI
  URI of the file
Returns undefined | URI
- Defined in packages/workspace/src/browser/workspace-service.ts:666

`Protected`init

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

isSafeToReload

isSafeToReload(withURI?: URI): Promise<boolean>
Parameters
- OptionalwithURI: URI
Returns Promise<boolean>
- Defined in packages/workspace/src/browser/workspace-service.ts:721

isUntitledWorkspace

isUntitledWorkspace(candidate?: URI): boolean
Parameters
- Optionalcandidate: URI
Returns boolean
- Defined in packages/workspace/src/browser/workspace-service.ts:717

`Protected`isWorkspaceFile

isWorkspaceFile(candidate: URI | FileStat): boolean
Check if the file should be considered as a workspace file.

Example: We should not try to read the contents of an .exe file.
Parameters
- candidate: URI | FileStat
Returns boolean
- Defined in packages/workspace/src/browser/workspace-service.ts:713

onStop

onStop(): void
on unload, we set our workspace root as the last recently used on the backend.

Returns void
Implementation of FrontendApplicationContribution.onStop
- Defined in packages/workspace/src/browser/workspace-service.ts:330

open

open(uri: URI, options?: WorkspaceInput): void
Opens directory, or recreates a workspace from the file that uri points to.
Parameters
- uri: URI
- Optionaloptions: WorkspaceInput
Returns void
- Defined in packages/workspace/src/browser/workspace-service.ts:361

`Protected`openNewWindow

openNewWindow(workspacePath: string, options?: WorkspaceInput): void
Parameters
- workspacePath: string
- Optionaloptions: WorkspaceInput
Returns void
- Defined in packages/workspace/src/browser/workspace-service.ts:547

`Protected`openWindow

openWindow(uri: FileStat, options?: WorkspaceInput): void
Parameters
- uri: FileStat
- Optionaloptions: WorkspaceInput
Returns void
- Defined in packages/workspace/src/browser/workspace-service.ts:525

openWorkspace

openWorkspace(uri: URI, options?: WorkspaceInput): Promise<void>
Parameters
- uri: URI
- Optionaloptions: WorkspaceInput
Returns Promise<void>
Implementation of WorkspaceOpenHandlerContribution.openWorkspace
- Defined in packages/workspace/src/browser/workspace-service.ts:379

recentWorkspaces

recentWorkspaces(): Promise<string[]>
Returns Promise<string[]>
- Defined in packages/workspace/src/browser/workspace-service.ts:334

`Protected`refreshRootWatchers

refreshRootWatchers(): Promise<void>
Returns Promise<void>
- Defined in packages/workspace/src/browser/workspace-service.ts:632

`Protected`reloadWindow

reloadWindow(workspacePath: string, options?: WorkspaceInput): void
Parameters
- workspacePath: string
- Optionaloptions: WorkspaceInput
Returns void
- Defined in packages/workspace/src/browser/workspace-service.ts:540

removeRecentWorkspace

removeRecentWorkspace(uri: string): Promise<void>
Parameters
- uri: string
Returns Promise<void>
- Defined in packages/workspace/src/browser/workspace-service.ts:338

removeRoots

removeRoots(uris: URI[]): Promise<void>
Removes root folder(s) from workspace.
Parameters
- uris: URI[]
Returns Promise<void>
- Defined in packages/workspace/src/browser/workspace-service.ts:412

save

save(uri: URI | FileStat): Promise<void>
Save workspace data into a file
Parameters
- uri: URI | FileStat
  URI or FileStat of the workspace file
Returns Promise<void>
- Defined in packages/workspace/src/browser/workspace-service.ts:591

`Protected`setURLFragment

setURLFragment(workspacePath: string): void
Set the URL fragment to the given workspace path.
Parameters
- workspacePath: string
Returns void
- Defined in packages/workspace/src/browser/workspace-service.ts:182

`Protected`setWorkspace

setWorkspace(workspaceStat: undefined | FileStat): Promise<void>
Parameters
- workspaceStat: undefined | FileStat
Returns Promise<void>
- Defined in packages/workspace/src/browser/workspace-service.ts:207

`Protected`shouldPreserveWindow

shouldPreserveWindow(options?: WorkspaceInput): boolean
Parameters
- Optionaloptions: WorkspaceInput
Returns boolean
- Defined in packages/workspace/src/browser/workspace-service.ts:553

spliceRoots

spliceRoots(
    start: number,
    deleteCount?: number,
    ...rootsToAdd: URI[],
): Promise<URI[]>
Parameters
- start: number
- OptionaldeleteCount: number
- ...rootsToAdd: URI[]
Returns Promise<URI[]>
- Defined in packages/workspace/src/browser/workspace-service.ts:428

`Protected`toFileStat

toFileStat(uri: undefined | string | URI): Promise<undefined | FileStat>
returns a FileStat if the argument URI points to a file or directory. Otherwise, undefined.
Parameters
- uri: undefined | string | URI
Returns Promise<undefined | FileStat>
- Defined in packages/workspace/src/browser/workspace-service.ts:509

`Protected`toValidRoot

toValidRoot(uri: undefined | string | URI): Promise<undefined | FileStat>
returns a FileStat if the argument URI points to an existing directory. Otherwise, undefined.
Parameters
- uri: undefined | string | URI
Returns Promise<undefined | FileStat>
- Defined in packages/workspace/src/browser/workspace-service.ts:498

tryGetRoots

tryGetRoots(): FileStat[]
Returns FileStat[]
- Defined in packages/workspace/src/browser/workspace-service.ts:189

`Protected`updateRoots

updateRoots(): Promise<void>
Returns Promise<void>
- Defined in packages/workspace/src/browser/workspace-service.ts:237

updateSchema

updateSchema(key: string, schema?: IJSONSchema): Promise<boolean>
Parameters
- key: string
  the property key under which to store the schema (e.g. tasks, launch)
- Optionalschema: IJSONSchema
  the schema for the property. If none is supplied, the update is treated as a deletion.
Returns Promise<boolean>
- Defined in packages/workspace/src/browser/workspace-service.ts:730

`Protected`updateTitle

updateTitle(): void
Returns void
- Defined in packages/workspace/src/browser/workspace-service.ts:301

`Protected`updateWorkspace

updateWorkspace(): Promise<void>
Returns Promise<void>
- Defined in packages/workspace/src/browser/workspace-service.ts:232

`Protected`watchRoot

watchRoot(root: FileStat): Promise<void>
Parameters
- root: FileStat
Returns Promise<void>
- Defined in packages/workspace/src/browser/workspace-service.ts:639

`Protected`watchRoots

watchRoots(): Promise<void>
Returns Promise<void>
- Defined in packages/workspace/src/browser/workspace-service.ts:620

`Protected`writeWorkspaceFile

writeWorkspaceFile(
workspaceFile: undefined | FileStat,
workspaceData: WorkspaceData,
): Promise<undefined | FileStat>
Parameters
- workspaceFile: undefined | FileStat
- workspaceData: WorkspaceData
Returns Promise<undefined | FileStat>
- Defined in packages/workspace/src/browser/workspace-service.ts:471

Class WorkspaceService

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns WorkspaceService

Properties

Protected_ready

Protected_roots

Protected_workspace

ProtecteddeferredRoots

Protected ReadonlyenvVariableServer

Protected ReadonlyfileService

Protected ReadonlyfsPreferences

Protected ReadonlylabelProvider

Protectedlogger

Protected ReadonlymessageService

Protected ReadonlyonWorkspaceChangeEmitter

Protected ReadonlyonWorkspaceLocationChangedEmitter

Protected ReadonlyopenHandlerContribution

Protected ReadonlypreferenceImpl

Protectedpreferences

Protected ReadonlyrootWatchers

Protected ReadonlyschemaService

Protected ReadonlyschemaUpdater

Protected Readonlyserver

Protected ReadonlytoDisposeOnWorkspace

Protected ReadonlyuntitledWorkspaceService

Protected ReadonlywindowService

Protected ReadonlywindowTitleService

Protected ReadonlyworkspaceFileService

Accessors

isMultiRootWorkspaceOpened

Returns boolean

onWorkspaceChanged

Returns Event<FileStat[]>

onWorkspaceLocationChanged

Returns Event<undefined | FileStat>

opened

Returns boolean

ready

Returns Promise<void>

roots

Returns Promise<FileStat[]>

saved

Returns boolean

workspace

Returns undefined | FileStat

Methods

addRoot

Parameters

Returns Promise<void>

areWorkspaceRoots

Parameters

Returns boolean

canHandle

Parameters

Returns Promise<boolean>

close

Returns Promise<void>

ProtectedcomputeRoots

Returns Promise<FileStat[]>

containsSome

Parameters

Returns Promise<boolean>

ProtecteddoGetDefaultWorkspaceUri

Returns Promise<undefined | string>

ProtecteddoInit

Returns Promise<void>

ProtecteddoOpen

Parameters

Returns Promise<void>

ProtectedgetDefaultWorkspaceUri

Returns MaybePromise<undefined | string>

ProtectedgetExcludes

`Protected`_ready

`Protected`_roots

`Protected`_workspace

`Protected`deferredRoots

`Protected` `Readonly`envVariableServer

`Protected` `Readonly`fileService

`Protected` `Readonly`fsPreferences

`Protected` `Readonly`labelProvider

`Protected`logger

`Protected` `Readonly`messageService

`Protected` `Readonly`onWorkspaceChangeEmitter

`Protected` `Readonly`onWorkspaceLocationChangedEmitter

`Protected` `Readonly`openHandlerContribution

`Protected` `Readonly`preferenceImpl

`Protected`preferences

`Protected` `Readonly`rootWatchers

`Protected` `Readonly`schemaService

`Protected` `Readonly`schemaUpdater

`Protected` `Readonly`server

`Protected` `Readonly`toDisposeOnWorkspace

`Protected` `Readonly`untitledWorkspaceService

`Protected` `Readonly`windowService

`Protected` `Readonly`windowTitleService

`Protected` `Readonly`workspaceFileService

`Protected`computeRoots

`Protected`doGetDefaultWorkspaceUri

`Protected`doInit

`Protected`doOpen

`Protected`getDefaultWorkspaceUri

`Protected`getExcludes

`Protected`getWorkspaceDataFromFile

`Protected`init

`Protected`isWorkspaceFile

`Protected`openNewWindow

`Protected`openWindow

`Protected`refreshRootWatchers

`Protected`reloadWindow

`Protected`setURLFragment

`Protected`setWorkspace

`Protected`shouldPreserveWindow

`Protected`toFileStat

`Protected`toValidRoot