FileSystemEntry: copyTo() method
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 thecompatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.
Non-standard: This feature is not standardized. We do not recommend using non-standard features in production, as they have limited browser support, and may change or be removed. However, they can be a suitable alternative in specific cases where no standard option exists.
TheFileSystemEntry interface's methodcopyTo() copies the filespecified by the entry to a new location on the file system.
There are sometypical 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 outsubfolders.
Syntax
copyTo(newParent)copyTo(newParent, newName)copyTo(newParent, newName, successCallback)copyTo(newParent, newName, successCallback, errorCallback)Parameters
newParentA
FileSystemDirectoryEntryobject specifying the destinationdirectory for the copy operation.newNameOptionalIf this parameter is provided, the copy is given this string as its new file ordirectory name.
successCallbackOptionalA function which is called when the copy operation is successfully completed.Receives a single input parameter: a
FileSystemEntrybased objectproviding the copied item's new details.errorCallbackOptionalAn optional callback which is executed if an error occurs while copying the items.There's a single parameter: a
DOMExceptiondescribing what went wrong.
Return value
None (undefined).
Exceptions
DOMException.INVALID_MODIFICATION_ERRThe requested operation involves an impossible change, such as moving a directoryinside itself or one of its own child directories, or copying an item within the samedirectory without renaming it.
DOMException.QUOTA_EXCEEDED_ERRThe operation exceeded the user's storage quota, or there isn't enough storage spaceleft to complete the operation.
Examples
This example shows how a temporary log file might be moved into a more permanent "log"directory.
workingDirectory.getFile( "tmp/log.txt", {}, (fileEntry) => { workingDirectory.getDirectory( "log", {}, (dirEntry) => { fileEntry.copyTo(dirEntry); }, handleError, ); }, handleError,);Browser compatibility
Loading…