Connection.removeDirectory(options)
Method Description |
Removes an empty directory. |
Returns |
void |
Supported Script Types |
Server scripts For more information, see SuiteScript 2.x Script Types. |
Governance |
10 units |
Module |
|
Since |
2019.2 |
Parameters
The options parameter is a JavaScript object.
Parameter |
Type |
Required / Optional |
Description |
Since |
---|---|---|---|---|
|
String |
required |
The relative path of a directory to be deleted. |
2019.2 |
Errors
Error Code |
Thrown If |
---|---|
|
Access to the file or directory on the remote FTP server was denied. |
|
Deleting a directory that does not exist. |
|
Deleting a directory that is not empty. |
Syntax
The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/sftp Module Script Samples.
// Add additional code
...
objConnection.removeDirectory({
path: 'relative/path/to/remote/dir'
});
...
//Add additional code