Class CollaborationWorkspaceService

The workspace service.

Hierarchy (View Summary)

WorkspaceService
- CollaborationWorkspaceService

Index

Constructors

constructor

Accessors

isMultiRootWorkspaceOpened onWorkspaceChanged onWorkspaceLocationChanged opened ready roots saved workspace

Constructors

constructor

new CollaborationWorkspaceService(): CollaborationWorkspaceService
Returns CollaborationWorkspaceService
Inherited from WorkspaceService.constructor

Properties

`Protected`_ready

_ready: Deferred<void>

`Protected`_roots

_roots: FileStat[]

`Protected`_workspace

_workspace: undefined | FileStat

`Protected` `Optional`collabWorkspace

collabWorkspace?: Workspace

`Protected` `Optional`connection

connection?: ProtocolBroadcastConnection

`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
Inherited from WorkspaceService.isMultiRootWorkspaceOpened
- Defined in workspace/lib/browser/workspace-service.d.ts:94

onWorkspaceChanged

get onWorkspaceChanged(): Event<FileStat[]>
Returns Event<FileStat[]>
Inherited from WorkspaceService.onWorkspaceChanged
- Defined in workspace/lib/browser/workspace-service.d.ts:69

onWorkspaceLocationChanged

get onWorkspaceLocationChanged(): Event<undefined | FileStat>
Returns Event<undefined | FileStat>
Inherited from WorkspaceService.onWorkspaceLocationChanged
- Defined in workspace/lib/browser/workspace-service.d.ts:71

opened

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

Returns boolean
Inherited from WorkspaceService.opened
- Defined in workspace/lib/browser/workspace-service.d.ts:89

ready

get ready(): Promise<void>
Returns Promise<void>
Inherited from WorkspaceService.ready
- Defined in workspace/lib/browser/workspace-service.d.ts:46

roots

get roots(): Promise<FileStat[]>
Returns Promise<FileStat[]>
Inherited from WorkspaceService.roots
- Defined in workspace/lib/browser/workspace-service.d.ts:65

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
Inherited from WorkspaceService.saved
- Defined in workspace/lib/browser/workspace-service.d.ts:140

workspace

get workspace(): undefined | FileStat
Returns undefined | FileStat
Inherited from WorkspaceService.workspace
- Defined in workspace/lib/browser/workspace-service.d.ts:67

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>
Inherited from WorkspaceService.addRoot
- Defined in workspace/lib/browser/workspace-service.d.ts:106

areWorkspaceRoots

areWorkspaceRoots(uris: URI[]): boolean
Parameters
- uris: URI[]
Returns boolean
Inherited from WorkspaceService.areWorkspaceRoots
- Defined in workspace/lib/browser/workspace-service.d.ts:164

canHandle

canHandle(uri: URI): Promise<boolean>
Parameters
- uri: URI
Returns Promise<boolean>
Inherited from WorkspaceService.canHandle
- Defined in workspace/lib/browser/workspace-service.d.ts:100

close

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

Returns Promise<void>
Inherited from WorkspaceService.close
- Defined in workspace/lib/browser/workspace-service.d.ts:117

`Protected`computeRoots

computeRoots(): Promise<FileStat[]>
Returns Promise<FileStat[]>
Overrides WorkspaceService.computeRoots
- Defined in collaboration/src/browser/collaboration-workspace-service.ts:49

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>
Inherited from WorkspaceService.containsSome
- Defined in workspace/lib/browser/workspace-service.d.ts:134

`Protected`doGetDefaultWorkspaceUri

doGetDefaultWorkspaceUri(): Promise<undefined | string>
Returns Promise<undefined | string>
Inherited from WorkspaceService.doGetDefaultWorkspaceUri
- Defined in workspace/lib/browser/workspace-service.d.ts:60

`Protected`doInit

doInit(): Promise<void>
Returns Promise<void>
Inherited from WorkspaceService.doInit
- Defined in workspace/lib/browser/workspace-service.d.ts:48

`Protected`doOpen

doOpen(uri: URI, options?: WorkspaceInput): Promise<void>
Parameters
- uri: URI
- Optionaloptions: WorkspaceInput
Returns Promise<void>
Inherited from WorkspaceService.doOpen
- Defined in workspace/lib/browser/workspace-service.d.ts:99

`Protected`entryToStat

entryToStat(entry: string): FileStat
Parameters
- entry: string
Returns FileStat
- Defined in collaboration/src/browser/collaboration-workspace-service.ts:57

`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>
Inherited from WorkspaceService.getDefaultWorkspaceUri
- Defined in workspace/lib/browser/workspace-service.d.ts:59

`Protected`getExcludes

getExcludes(uri: string): string[]
Parameters
- uri: string
Returns string[]
Inherited from WorkspaceService.getExcludes
- Defined in workspace/lib/browser/workspace-service.d.ts:150

getUntitledWorkspace

getUntitledWorkspace(): Promise<URI>
Returns Promise<URI>
Inherited from WorkspaceService.getUntitledWorkspace
- Defined in workspace/lib/browser/workspace-service.d.ts:112

`Protected`getWorkspaceDataFromFile

getWorkspaceDataFromFile(): Promise<undefined | WorkspaceData>
Returns Promise<undefined | WorkspaceData>
Inherited from WorkspaceService.getWorkspaceDataFromFile
- Defined in workspace/lib/browser/workspace-service.d.ts:77

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)
Inherited from WorkspaceService.getWorkspaceRelativePath
- Defined in workspace/lib/browser/workspace-service.d.ts:163

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
Inherited from WorkspaceService.getWorkspaceRootUri
- Defined in workspace/lib/browser/workspace-service.d.ts:157

`Protected`init

init(): void
Returns void
Inherited from WorkspaceService.init
- Defined in workspace/lib/browser/workspace-service.d.ts:47

isSafeToReload

isSafeToReload(withURI?: URI): Promise<boolean>
Parameters
- OptionalwithURI: URI
Returns Promise<boolean>
Inherited from WorkspaceService.isSafeToReload
- Defined in workspace/lib/browser/workspace-service.d.ts:172

isUntitledWorkspace

isUntitledWorkspace(candidate?: URI): boolean
Parameters
- Optionalcandidate: URI
Returns boolean
Inherited from WorkspaceService.isUntitledWorkspace
- Defined in workspace/lib/browser/workspace-service.d.ts:171

`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
Inherited from WorkspaceService.isWorkspaceFile
- Defined in workspace/lib/browser/workspace-service.d.ts:170

onStop

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

Returns void
Inherited from WorkspaceService.onStop
- Defined in workspace/lib/browser/workspace-service.d.ts:82

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
Inherited from WorkspaceService.open
- Defined in workspace/lib/browser/workspace-service.d.ts:98

`Protected`openNewWindow

openNewWindow(workspacePath: string, options?: WorkspaceInput): void
Parameters
- workspacePath: string
- Optionaloptions: WorkspaceInput
Returns void
Inherited from WorkspaceService.openNewWindow
- Defined in workspace/lib/browser/workspace-service.d.ts:128

`Protected`openWindow

openWindow(uri: FileStat, options?: WorkspaceInput): void
Parameters
- uri: FileStat
- Optionaloptions: WorkspaceInput
Returns void
Inherited from WorkspaceService.openWindow
- Defined in workspace/lib/browser/workspace-service.d.ts:126

openWorkspace

openWorkspace(uri: URI, options?: WorkspaceInput): Promise<void>
Parameters
- uri: URI
- Optionaloptions: WorkspaceInput
Returns Promise<void>
Inherited from WorkspaceService.openWorkspace
- Defined in workspace/lib/browser/workspace-service.d.ts:101

recentWorkspaces

recentWorkspaces(): Promise<string[]>
Returns Promise<string[]>
Inherited from WorkspaceService.recentWorkspaces
- Defined in workspace/lib/browser/workspace-service.d.ts:83

`Protected`refreshRootWatchers

refreshRootWatchers(): Promise<void>
Returns Promise<void>
Inherited from WorkspaceService.refreshRootWatchers
- Defined in workspace/lib/browser/workspace-service.d.ts:148

`Protected`reloadWindow

reloadWindow(workspacePath: string, options?: WorkspaceInput): void
Parameters
- workspacePath: string
- Optionaloptions: WorkspaceInput
Returns void
Inherited from WorkspaceService.reloadWindow
- Defined in workspace/lib/browser/workspace-service.d.ts:127

removeRecentWorkspace

removeRecentWorkspace(uri: string): Promise<void>
Parameters
- uri: string
Returns Promise<void>
Inherited from WorkspaceService.removeRecentWorkspace
- Defined in workspace/lib/browser/workspace-service.d.ts:84

removeRoots

removeRoots(uris: URI[]): Promise<void>
Removes root folder(s) from workspace.
Parameters
- uris: URI[]
Returns Promise<void>
Inherited from WorkspaceService.removeRoots
- Defined in workspace/lib/browser/workspace-service.d.ts:110

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>
Inherited from WorkspaceService.save
- Defined in workspace/lib/browser/workspace-service.d.ts:145

setHostWorkspace

setHostWorkspace(
workspace: Workspace,
connection: ProtocolBroadcastConnection,
): Promise<Disposable>
Parameters
- workspace: Workspace
- connection: ProtocolBroadcastConnection
Returns Promise<Disposable>
- Defined in collaboration/src/browser/collaboration-workspace-service.ts:31

`Protected`setURLFragment

setURLFragment(workspacePath: string): void
Set the URL fragment to the given workspace path.
Parameters
- workspacePath: string
Returns void
Inherited from WorkspaceService.setURLFragment
- Defined in workspace/lib/browser/workspace-service.d.ts:64

`Protected`setWorkspace

setWorkspace(workspaceStat: undefined | FileStat): Promise<void>
Parameters
- workspaceStat: undefined | FileStat
Returns Promise<void>
Inherited from WorkspaceService.setWorkspace
- Defined in workspace/lib/browser/workspace-service.d.ts:73

`Protected`shouldPreserveWindow

shouldPreserveWindow(options?: WorkspaceInput): boolean
Parameters
- Optionaloptions: WorkspaceInput
Returns boolean
Inherited from WorkspaceService.shouldPreserveWindow
- Defined in workspace/lib/browser/workspace-service.d.ts:129

spliceRoots

spliceRoots(
    start: number,
    deleteCount?: number,
    ...rootsToAdd: URI[],
): Promise<URI[]>
Parameters
- start: number
- OptionaldeleteCount: number
- ...rootsToAdd: URI[]
Returns Promise<URI[]>
Inherited from WorkspaceService.spliceRoots
- Defined in workspace/lib/browser/workspace-service.d.ts:111

`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>
Inherited from WorkspaceService.toFileStat
- Defined in workspace/lib/browser/workspace-service.d.ts:125

`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>
Inherited from WorkspaceService.toValidRoot
- Defined in workspace/lib/browser/workspace-service.d.ts:121

tryGetRoots

tryGetRoots(): FileStat[]
Returns FileStat[]
Inherited from WorkspaceService.tryGetRoots
- Defined in workspace/lib/browser/workspace-service.d.ts:66

`Protected`updateRoots

updateRoots(): Promise<void>
Returns Promise<void>
Inherited from WorkspaceService.updateRoots
- Defined in workspace/lib/browser/workspace-service.d.ts:75

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>
Inherited from WorkspaceService.updateSchema
- Defined in workspace/lib/browser/workspace-service.d.ts:178

`Protected`updateTitle

updateTitle(): void
Returns void
Inherited from WorkspaceService.updateTitle
- Defined in workspace/lib/browser/workspace-service.d.ts:78

`Protected`updateWorkspace

updateWorkspace(): Promise<void>
Returns Promise<void>
Inherited from WorkspaceService.updateWorkspace
- Defined in workspace/lib/browser/workspace-service.d.ts:74

`Protected`watchRoot

watchRoot(root: FileStat): Promise<void>
Parameters
- root: FileStat
Returns Promise<void>
Inherited from WorkspaceService.watchRoot
- Defined in workspace/lib/browser/workspace-service.d.ts:149

`Protected`watchRoots

watchRoots(): Promise<void>
Returns Promise<void>
Inherited from WorkspaceService.watchRoots
- Defined in workspace/lib/browser/workspace-service.d.ts:147

`Protected`writeWorkspaceFile

writeWorkspaceFile(
workspaceFile: undefined | FileStat,
workspaceData: WorkspaceData,
): Promise<undefined | FileStat>
Parameters
- workspaceFile: undefined | FileStat
- workspaceData: WorkspaceData
Returns Promise<undefined | FileStat>
Inherited from WorkspaceService.writeWorkspaceFile
- Defined in workspace/lib/browser/workspace-service.d.ts:113

Class CollaborationWorkspaceService

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns CollaborationWorkspaceService

Properties

Protected_ready

Protected_roots

Protected_workspace

Protected OptionalcollabWorkspace

Protected Optionalconnection

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>

ProtectedentryToStat

Parameters

`Protected`_ready

`Protected`_roots

`Protected`_workspace

`Protected` `Optional`collabWorkspace

`Protected` `Optional`connection

`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`entryToStat

`Protected`getDefaultWorkspaceUri

`Protected`getExcludes

`Protected`getWorkspaceDataFromFile

`Protected`init

`Protected`isWorkspaceFile

`Protected`openNewWindow

`Protected`openWindow

`Protected`refreshRootWatchers

`Protected`reloadWindow

`Protected`setURLFragment

`Protected`setWorkspace

`Protected`shouldPreserveWindow