Constructor
new FileSystemDirectoryEntry()
- Source:
- See:
Methods
createReader() → {webdav.FileSystemDirectoryReader}
Creates a webdav.FileSystemDirectoryReader object which can be used to read the entries in this directory.
Returns:
A webdav.FileSystemDirectoryReader object which can be used to read the directory’s entries.
getDirectory(pathopt, nullable, optionsopt, successCallbackopt, errorCallbackopt) → {void}
Returns a webdav.FileSystemDirectoryEntry object representing a directory located at a given path, relative to the directory on which the method is called.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
path |
string |
<optional> <nullable> |
A USVString representing an absolute path or a path relative to the directory on which the method is called, describing which directory entry to return. |
options |
external:FileSystemFlags |
<optional> |
An object based on the {external:FileSystemFlags} dictionary, which allows you to specify whether or not to create the entry if it's missing and if it's an error if the file already exists. |
successCallback |
webdav.FileSystemEntryCallback |
<optional> |
A method to be called once the webdav.FileSystemEntryCallback has been created. The method receives a single parameter: the webdav.FileSystemEntryCallback object representing the directory in question. |
errorCallback |
external:ErrorCallback |
<optional> |
A method to be called if an error occurs. Receives as its sole input parameter a external:DOMException object describing the error which occurred. |
Returns:
- Type
- void
getFile(pathopt, nullable, optionsopt, successCallbackopt, errorCallbackopt) → {void}
Returns a webdav.FileSystemFileEntry object representinga file located within the directory’s hierarchy, given a path relative to the directory on which the method is called.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
path |
string |
<optional> <nullable> |
A |
options |
external:FileSystemFlags |
<optional> |
An object based on the external:FileSystemFlags dictionary, which allows you to specify whether or not to create the entry if it’s missing and if it’s an error if the file already exists. This method returns dummy instance instead of creating an empty file. |
successCallback |
webdav.FileSystemEntryCallback |
<optional> |
A method to be called once the webdav.FileSystemFileEntry has been created. The method receives a single parameter: the webdav.FileSystemFileEntry object representing the file in question. |
errorCallback |
external:ErrorCallback |
<optional> |
A method to be called if an error occurs. Receives as its sole input parameter a external:DOMException object describing the error which occurred. |
Returns:
- Type
- void
removeRecursively(successCallback, errorCallbackopt) → {void}
Deletes a directory and all of its contents, including the contents of subdirectories.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
successCallback |
external:VoidCallback | A function to call once the directory removal process has completed. The callback has no parameters. |
|
errorCallback |
external:ErrorCallback |
<optional> |
A function to be called if an error occurs while attempting to remove the directory subtree. Receives a external:DOMException describing the error which occurred as input. |
- Source:
- See:
Returns:
- Type
- void