Files.Download

Overview

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

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

Arguments

string name

Name of file to be saved.

string mimeType

Mime type of file

FileTransferOptions options

Download options. See FileTransferOptions for more details.

Example

Downloading file from url

//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 to authenticate on remote environment. Optional. Password : string // Port number of remote environment. Optional. Port : number // Protocol to use for file transfer. Optional. Default is FTP. Protocol : ( "FTP" | "FTPS" | "SFTP" | "HTTP" | "HTTPS" ) // IP address or host name of remote environment. RemoteHost : string // Path of file on remote environment. RemotePath : string // Username to authenticate on remote environment. Optional. UserName : string }

Emakin Documentation