Interface FileEntry

public copyTo(parent: DirectoryEntry, newName?: string, successCallback?: (entry: Entry) => void, errorCallback?: (error: Error) => void)

Copy an entry to a different location on the file system. It is an error to try to: copy a directory inside itself or to any child at any depth; copy an entry into its parent if a name different from its current one isn't provided; copy a file to a path occupied by a directory; copy a directory to a path occupied by a file; copy any element to a path occupied by a directory which is not empty. A copy of a file on top of an existing file must attempt to delete and replace that file. A copy of a directory on top of an existing empty directory must attempt to delete and replace that directory. Directory copies are always recursive--that is, they copy all contents of the directory.

Parameters

• parent: DirectoryEntry

  The directory to which to move the entry.

• newName?: string optional

  The new name of the entry. Defaults to the Entry's current name if unspecified.

• successCallback?: (entry: Entry) => void optional

  A callback that is called with the Entry for the new object.

• errorCallback?: (error: Error) => void optional

  A callback that is called when errors happen.

public getMetadata(successCallback: (metadata: Metadata) => void, errorCallback?: (error: Error) => void)

Look up metadata about this entry.

Parameters

• successCallback: (metadata: Metadata) => void

  A callback that is called with the time of the last modification.

• errorCallback?: (error: Error) => void optional

  A callback that is called when errors happen.

public getParent(successCallback: (entry: Entry) => void, errorCallback?: (error: Error) => void)

Look up the parent DirectoryEntry containing this Entry. If this Entry is the root of its filesystem, its parent is itself.

Parameters

• successCallback: (entry: Entry) => void

  A callback that is called with the time of the last modification.

• errorCallback?: (error: Error) => void optional

  A callback that is called when errors happen.

public moveTo(parent: DirectoryEntry, newName?: string, successCallback?: (entry: Entry) => void, errorCallback?: (error: Error) => void)

Move an entry to a different location on the file system. It is an error to try to: move a directory inside itself or to any child at any depth;move an entry into its parent if a name different from its current one isn't provided; move a file to a path occupied by a directory; move a directory to a path occupied by a file; move any element to a path occupied by a directory which is not empty. A move of a file on top of an existing file must attempt to delete and replace that file. A move of a directory on top of an existing empty directory must attempt to delete and replace that directory.

Parameters

• parent: DirectoryEntry

  The directory to which to move the entry.

• newName?: string optional

  The new name of the entry. Defaults to the Entry's current name if unspecified.

• successCallback?: (entry: Entry) => void optional

  A callback that is called with the Entry for the new location.

• errorCallback?: (error: Error) => void optional

  A callback that is called when errors happen.

public remove(successCallback: () => void, errorCallback?: (error: Error) => void)

Deletes a file or directory. It is an error to attempt to delete a directory that is not empty. It is an error to attempt to delete the root directory of a filesystem.

Parameters

• successCallback: () => void

  A callback that is called on success.

• errorCallback?: (error: Error) => void optional

  A callback that is called when errors happen.

public toURL(): string

Returns

string