Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

Uploads the specified file to remote environment.

void myFiles.Upload(id: string, options: FileTransferOptions)

Arguments

string id
Id number of file to upload
Instance of ,FileTransferOptions

Remarks

If port number is specified passive mode is automatically disabled, to enable it please remove the port number from options.

Example

Uploading file via FTP into a folder located on a remote server

Code Block
languagejs
var fileId = $Xml.Evaluate('File/FileId');
//Create File Transfer Option..
var fileTransferOptions = {
    RemoteHost : '192.168.1.28',
    RemotePath : 'testfolder' + '/' + 'testdoc.pdf',
    Username : 'myUsername',
    Password : 'myPassword',
    Protocol : 'FTP'
};

//Uploading..
$Files.Upload(fileId, fileTransferOptions)
````
@see {@link FileTransferOptions}

Types

FileTransferOptions

Options for file transfer operations.

{ Password : string Port : number Protocol : string RemoteHost : string RemotePath : string UserName : string }