HttpAliases.

DownloadFile(ICakeContext, Uri, DownloadFileSettings) Method

Summary

Downloads the specified resource over HTTP to a temporary file with specified settings.
Namespace
Cake.Common.Net
Containing Type
HttpAliases

Syntax

[CakeMethodAlias]
[CakeAliasCategory("Download")]
public static FilePath DownloadFile(this ICakeContext context, Uri address, DownloadFileSettings settings)

Examples

var address = new Uri("http://www.example.org/index.html");
var resource = DownloadFile(address, new DownloadFileSettings()
{
    Username = "bob",
    Password = "builder"
});

Attributes

Type Description
CakeMethodAliasAttribute An attribute used to mark script method aliases.
CakeAliasCategoryAttribute An attribute used for documentation of alias methods/properties.

Parameters

Name Type Description
context ICakeContext The context.
address Uri The URL of file to download.
settings DownloadFileSettings The settings.

Return Value

Type Description
FilePath The path to the downloaded file.