Connection.removeFile(options)
Method Description |
Removes a file. |
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 the directory location where this file should be removed. |
2019.2 |
Errors
Error Code |
Thrown If |
---|---|
|
Access to the file or directory on the remote FTP server was denied. |
|
The file or directory does not exist. |
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.removeFile({
path: 'relative/path/test
});
...
//Add additional code