Connection.move(options)
Method Description |
Moves a file or directory from one location to another. |
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 file to be moved from. |
2019.2 |
|
String |
required |
The relative path of the file to be moved to. |
2019.2 |
Errors
Error Code |
Thrown If |
---|---|
|
Source is not readable or the target is not writable. Source or target 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.move({
from: 'relative/path/to/remote/dir',
to: 'relative/path/to/remote/dir/new'
});
...
// Add additional code