FileSystemEntry.copyTo()

Deprecated

This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

The FileSystemEntry interface's method copyTo() copies the file specified by the entry to a new location on the file system. There are some typical restrictions on what you can do:

  • A directory can't be copied into itself.
  • An entry can't be copied into its parent directory unless you specify a new name.
  • When copying a directory, the copy is always recursive; you can't leave out subfolders.

Syntax

FileSystemEntry.copyTo(newParent[, newName][, successCallback][, errorCallback]);

Parameters

newParent
A FileSystemDirectoryEntry object specifying the destination directory for the copy operation.
newName Optional
If this parameter is provided, the copy is given this string as its new file or directory name.
successCallback Optional
A function which is called when the copy operation is successfully completed. Receives a single input parameter: a FileSystemEntry based object providing the copied item's new details.
errorCallback Optional
An optional callback which is executed if an error occurs while copying the items. There's a single parameter: a FileError describing what went wrong.

Return value

Errors

FileError.INVALID_MODIFICATION_ERR
The requested operation involves an impossible change, such as moving a directory inside itself or one of its own child directories, or copying an item within the same directory without renaming it.
FileError.QUOTA_EXCEEDED_ERR
The operation exceeded the user's storage quota, or there isn't enough storage space left to complete the operation.

Example

This example shows how a temporary log file might be moved into a more permanent "log" directory.

workingDirectory.getFile("tmp/log.txt", {}, function(fileEntry) {
  workingDirectory.getDirectory("log", {}, function(dirEntry) {
    fileEntry.copyTo(dirEntry);
  }, handleError);
}, handleError);

Browser compatibility

BCD tables only load in the browser

See also