Class orion.fileClient.FileClient
The file client provides a convenience API for interacting with file services
provided by plugins. This class handles authorization, and authentication-related
error handling.
Defined in: </shared/eclipse/e4/orion/I201404012230/bundles/org.eclipse.orion.client.core/web/orion/fileClient.js>.
Constructor Attributes | Constructor Name and Description |
---|---|
Creates a new file client.
|
Method Attributes | Method Name and Description |
---|---|
copyFile(sourceLocation, targetLocation, name)
Copies a file or directory.
|
|
createFile(parentLocation, fileName)
Create a new file in a specified location.
|
|
createFolder(parentLocation, folderName)
Creates a folder.
|
|
createProject(url, projectName, serverPath, create)
Adds a project to a workspace.
|
|
createWorkspace(name)
Creates a new workspace with the given name.
|
|
deleteFile(location)
Deletes a file, directory, or project.
|
|
fetchChildren(location)
Obtains the children of a remote resource
|
|
fileServiceName(location)
Returns the name of the file service managing this location
|
|
fileServiceRootURL(location)
Returns the root url of the file service managing this location
|
|
getService(location)
Returns the file service managing this location
|
|
loadWorkspace(location, onLoad)
Loads the workspace with the given id and sets it to be the current
workspace for the IDE.
|
|
Loads all the user's workspaces.
|
|
moveFile(sourceLocation, targetLocation, name)
Moves a file or directory.
|
|
read(location, isMetadata)
Returns the contents or metadata of the file at the given location.
|
|
readBlob(location)
Returns the blob contents of the file at the given location.
|
|
remoteExport(sourceLocation, options)
Exports file and directory contents to another server
|
|
remoteImport(targetLocation, options)
Imports file and directory contents from another server
|
|
search(searchParams)
Performs a search with the given search parameters.
|
|
write(location, contents, args)
Writes the contents or metadata of the file at the given location.
|
- Parameters:
- {String} sourceLocation
- The location of the file or directory to copy.
- {String} targetLocation
- The location of the target folder.
- {String} name Optional
- The name of the destination file or directory in the case of a rename
- Parameters:
- {String} parentLocation
- The location of the parent folder
- {String} fileName
- The name of the file to create
- Returns:
- {Object} A deferred that will provide the new file object
- Parameters:
- {String} parentLocation
- The location of the parent folder
- {String} folderName
- The name of the folder to create
- Returns:
- {Object} JSON representation of the created folder
- Parameters:
- {String} url
- The workspace location
- {String} projectName
- the human-readable name of the project
- {String} serverPath
- The optional path of the project on the server.
- {Boolean} create
- If true, the project is created on the server file system if it doesn't already exist
- Parameters:
- {String} name
- The name of the new workspace
- Parameters:
- {String} location
- The location of the file or directory to delete.
- Parameters:
- location
- The location of the item to obtain children for
- Returns:
- A deferred that will provide the array of child objects when complete
- Parameters:
- location
- The location of the item
- Parameters:
- location
- The location of the item
- Parameters:
- location
- The location of the item
- Parameters:
- {String} location
- the location of the workspace to load
- {Function} onLoad
- the function to invoke when the workspace is loaded
- Parameters:
- {String} sourceLocation
- The location of the file or directory to move.
- {String} targetLocation
- The location of the target folder.
- {String} name Optional
- The name of the destination file or directory in the case of a rename
- Parameters:
- {String} location
- The location of the file to get contents for
- {Boolean} isMetadata Optional
- If defined and true, returns the file metadata, otherwise file contents are returned
- Returns:
- A deferred that will be provided with the contents or metadata when available
- Parameters:
- {String} location
- The location of the file to get contents for
- Returns:
- A deferred that will be provided with the blob contents when available
- Parameters:
- {String} sourceLocation
- The location of the folder to export from
- {Object} options
- An object specifying the export parameters
- Returns:
- A deferred for chaining events after the export completes
- Parameters:
- {String} targetLocation
- The location of the folder to import into
- {Object} options
- An object specifying the import parameters
- Returns:
- A deferred for chaining events after the import completes
- Parameters:
- {Object} searchParams
- The JSON object that describes all the search parameters.
- {String} searchParams.resource
- Required. The location where search is performed. Required. Normally a sub folder of the file system. Empty string means the root of the file system.
- {String} searchParams.keyword
- The search keyword. Required but can be empty string. If fileType is a specific type and the keyword is empty, then list up all the files of that type. If searchParams.regEx is true then the keyword has to be a valid regular expression.
- {String} searchParams.sort
- Required. Defines the order of the return results. Should be either "Path asc" or "Name asc". Extensions are possible but not currently supported.
- {boolean} searchParams.nameSearch
- Optional. If true, the search performs only file name search.
- {String} searchParams.fileType
- Optional. The file type. If specified, search will be performed under this file type. E.g. "*.*" means all file types. "html" means html files.
- {Boolean} searchParams.regEx
- Optional. The option of regular expression search.
- {integer} searchParams.start
- Optional. The zero based strat number for the range of the returned hits. E.g if there are 1000 hits in total, then 5 means the 6th hit.
- {integer} searchParams.rows
- Optional. The number of hits of the range. E.g if there are 1000 hits in total and start=5 and rows=40, then the return range is 6th-45th.
- Parameters:
- {String} location
- The location of the file to set contents for
- {String|Object} contents
- The content string, or metadata object to write
- {String|Object} args
- Additional arguments used during write operation (i.e. ETag)
- Returns:
- A deferred for chaining events after the write completes with new metadata object