Class: FileSystemEntry

webdav.FileSystemEntry

The basic interface representing a single entry in a file system. This is implemented by other interfaces which represent files or directories.

Source:
See:

Members

(readonly) fullPath :string

An absolute-URL string.

Type:
  • string
Source:
See:

(readonly) isDirectory :boolean

A Boolean which is true if the entry represents a directory; otherwise, it’s false.

Type:
  • boolean
Source:
See:

(readonly) isFile :boolean

A Boolean which is true if the entry represents a file. If it’s not a file, this value is false.

Type:
  • boolean
Source:
See:

(readonly) name :string

A USVString containing the name of the entry (the final part of the path, after the last “/” character).

Type:
  • string
Source:
See:

Methods

getMetadata(successCallback, errorCallbackopt) → {void}

Obtains metadata about the file, such as its modification date and size.

Parameters:
Name Type Attributes Description
successCallback webdav.MetadataCallback

A function which is called when looking up the metadata is succesfully completed. Receives a single input parameter: a webdav.Metadata object with information about the file. This is information at the time of the instance of wevdav.FileSystemEntry created.
errorCallback external:ErrorCallback <optional>

An optional callback which is executed if an error occurs while looking up the metadata. There’s a single parameter: a external:DOMException describing what went wrong.
Source:
See:
Returns:
Type
void

getParent(successCallbackopt, errorCallbackopt) → {void}

Returns a webdav.FileSystemDirectoryEntry representing the entry’s parent directory.

Parameters:
Name Type Attributes Description
successCallback webdav.FileSystemEntryCallback <optional>

A function which is called when the parent directory entry has been retrieved. The callback receives a single input parameter: a webdav.FileSystemDirectoryEntry object representing the parent directory. The parent of the root directory is considered to be the root directory, itself, so be sure to watch for that.
errorCallback external:ErrorCallback <optional>

An optional callback which is executed if an error occurs. There’s a single parameter: a external:DOMException describing what went wrong.
Source:
See:
Returns:
Type
void

remove(successCallback, errorCallbackopt) → {void}

Removes the specified file or directory. You can only remove directories which are empty.

Parameters:
Name Type Attributes Description
successCallback external:VoidCallback

A function which is called once the file has been successfully removed.
errorCallback external:ErrorCallback <optional>

An optional callback which is called if the attempt to remove the file fails.
Source:
See:
Returns:
Type
void