Skip to content

Download

Downloads a file from remote environment stores in repository and returns created file info.

1
myFiles.Download(name: string, mimeType: string, options: FileTransferOptions):FileInfo

Parameters

string name
    Name of file to be saved.

string mimeType
    Mime type of file

FileTransferOptions options
    Download options. See FileTransferOptions for more details.

Remarks

Downloading file from url

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
//Creating File Transfer Option
var fileTransferOptions = {
    RemoteHost : 'www.emakin.com',   //Url
    RemotePath : 'images/image.jpg', //Location
    Port : 80,                       //Port
    Protocol : 'HTTP'                //Protocol
};

//Downloading File
var file = $Files.Download("FileName", 'image/jpeg', fileTransferOptions);

Types

FileTransferOptions

Options for file transfer operations.

Password : string
Password to authenticate on remote environment. Optional.

Port : number
Port number of remote environment. Optional.

Protocol : ( "FTP" | "FTPS" | "SFTP" | "HTTP" | "HTTPS" )
Protocol to use for file transfer. Optional. Default is FTP.

RemoteHost : string
IP address or host name of remote environment.

RemotePath : string
Path of file on remote environment.

UserName : string
Username to authenticate on remote environment. Optional.

See Also