Skip to content

Moving a File/Directory

Renames a file or a directory in the Backendless file storage:

Non-Blocking API

public void moveFile( String sourcePathName, String targetPath, AsyncCallback<String> responder )

Blocking API

public String moveFile( String sourcePathName, String targetPath )

where:

Argument                Description
sourcePathName a path identifying file or directory to move. The path must start with the root directory of the remote file storage.
targetPath a path to a directory where the source file or directory should be moved to. If the directory does not exist, it is created.
responder a responder object which receives a callback when the method successfully completes or if an error occurs. Applies to the asynchronous method only.

Return value

Absolute path to the copied file or directory.

Example

The example below describes how to move a file called readme.txt located in the /documentationdirectory to the /updated-docs directory:

Backendless.Files.moveFile( "/documentation/readme.txt", "/updated-docs" );

Errors

The server may return the following errors:

Error Code
Error message
Notes
4000
User has no permissions to specified resource
Occurs when the user (anonymous or logged in) has no permission to modify the file
6000
File or directory cannot be found.
Occurs when the source file/directory cannot be found.
6006
Path contains prohibited symbols: {path name}

6007
The specified resource was not found
Occurs when the API requests to rename a non-existent file or a directory.
6018
Unable to modify file/folder: file/folder already exists: {file/directory name}
Occurs when the target file/directory already exists.
6021
Unable to move file to file

6023
File already exists in target directory

6028
Parameter {param name} cannot be null
Occurs when one of the parameters is null.
8010
Missing field {field name}
Occurs in REST APIs when one of the required fields is missing in the body.
8011
Content type should be 'application/json'
Occurs in REST API when the request's content type is not application/json