WebDownload Class

Summary

Defines a task that downloads one or more files from a remote server.
Namespace
NBuildKit.MsBuild.Tasks.Web
Base Types
graph TD Base0["BaseTask"]-->Type click Base0 "/nBuildKit.MsBuild/api/NBuildKit.MsBuild.Tasks.Core/BaseTask" Base1["Task"]-->Base0 Type["WebDownload"] class Type type-node

Syntax

public sealed class WebDownload : BaseTask

Constructors

Name Summary
WebDownload() Initializes a new instance of the WebDownload class.
WebDownload(Func<IInternalWebClient>) Initializes a new instance of the WebDownload class.

Properties

Name Value Summary
DestinationDirectory ITaskItem
Gets or sets the directory into which the file should be placed.
ErrorInformation ITaskItem[]
Gets or sets the collection containing the error codes for the task.
Inherited from BaseTask
Name string
Gets or sets the optional name of the file in the local file system.
OutputPath ITaskItem
Gets or sets the path to the location of the downloaded file on the local file system.
Password string
Gets or sets the password that should be used to access the HTTP resource.
Source ITaskItem
Gets or sets the URL from which the file should be downloaded.
UseDefaultCredentials bool
Gets or sets a value indicating whether or not the default credentials should be passed to the HTTP resource.
UserName string
Gets or sets the username that should be used to access the HTTP resource.

Methods

Name Value Summary
ErrorCodeById(string) string
Returns the error code for the given ID.
Inherited from BaseTask
Execute() bool
GetAbsolutePath(ITaskItem) string
Returns the absolute path for the given path item.
Inherited from BaseTask
GetAbsolutePath(ITaskItem, ITaskItem) string
Returns the absolute path for the given path item.
Inherited from BaseTask
GetAbsolutePath(string) string
Returns the absolute path for the given path item.
Inherited from BaseTask
VerbosityForCurrentMsBuildInstance() string
Gets the verbosity that the current MsBuild instance is running at.
Inherited from BaseTask
static