Skip to content

Renaming a File/Directory


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

Blocking API

public String renameFile( String oldPathName, String newName )

Non-Blocking API

public void renameFile( String oldPathName, String newName, AsyncCallback<String> responder )

where:

Argument                Description
oldPathName a path identifying file or directory to be renamed. The must start with the root directory for the file storage allocated to the application.
newName new name for the file or directory.
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 of the renamed file or directory.

Example

The example below describes how to rename a file called readme.txt located in the /documentation directory to readme-first.txt:

Backendless.Files.renameFile( "/documentation/readme.txt", "readme-first.txt" );

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.
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.