NuGetInstall Class

Summary

Defines a ITask that performs a NuGet install.
Namespace
NBuildKit.MsBuild.Tasks.Packaging
Base Types
graph TD Base0["NuGetCommandLineToolTask"]-->Type click Base0 "/nBuildKit.MsBuild/api/NBuildKit.MsBuild.Tasks.Core/NuGetCommandLineToolTask" Base1["CommandLineToolTask"]-->Base0 click Base1 "/nBuildKit.MsBuild/api/NBuildKit.MsBuild.Tasks.Core/CommandLineToolTask" Base2["BaseTask"]-->Base1 click Base2 "/nBuildKit.MsBuild/api/NBuildKit.MsBuild.Tasks.Core/BaseTask" Base3["Task"]-->Base2 Type["NuGetInstall"] class Type type-node

Syntax

public sealed class NuGetInstall : NuGetCommandLineToolTask

Constructors

Name Summary
NuGetInstall() Initializes a new instance of the NuGetInstall class.
NuGetInstall(IApplicationInvoker) Initializes a new instance of the NuGetInstall class.

Properties

Name Value Summary
DefaultDataHandler DataReceivedEventHandler
Gets the event handler that processes data from the data stream, or standard output stream, of the command line application.By default logs a message for each output.
Inherited from CommandLineToolTask
DefaultErrorHandler DataReceivedEventHandler
Gets the event handler that processes data from the data stream, or standard output stream, of the command line application.By default logs a message for each output.
Inherited from CommandLineToolTask
ErrorInformation ITaskItem[]
Gets or sets the collection containing the error codes for the task.
Inherited from BaseTask
ExcludeVersion bool
Gets or sets a value indicating whether or not the version of the package should be included in the install directory.
LogEnvironmentVariables bool
Gets or sets a value indicating whether the environment variables for the process should be logged.
Inherited from CommandLineToolTask
NuGetExecutablePath ITaskItem
Gets or sets the path to the NuGet command line executable.
PackageName string
Gets or sets the name of the package that should be installed.
PackagesDirectory ITaskItem
Gets or sets the full path to the directory into which the package should be installed.
PackageVersion string
Gets or sets the version of the package that should be installed.
Sources ITaskItem[]
Gets or sets the NuGet sources from which the package may be taken.
WorkingDirectory ITaskItem
Gets or sets the full path to the working directory

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
GetFullToolPath(ITaskItem) string
Returns the most complete path for the given executable tool. May return just the name of the tool if the tool path is found via the PATH environment variable.
Inherited from CommandLineToolTask
GetFullToolPath(string) string
Returns the most complete path for the given executable tool. May return just the name of the tool if the tool path is found via the PATH environment variable.
Inherited from CommandLineToolTask
InvokeCommandLineTool(ITaskItem, IEnumerable<string>, ITaskItem, DataReceivedEventHandler, DataReceivedEventHandler) int
Invokes the command line tool at the given path with the given arguments.
Inherited from CommandLineToolTask
InvokeCommandLineTool(string, IEnumerable<string>, string, DataReceivedEventHandler, DataReceivedEventHandler) int
Invokes the command line tool at the given path with the given arguments.
Inherited from CommandLineToolTask
InvokeNuGet(IEnumerable<string>, DataReceivedEventHandler) int
Invokes the NuGet command line tool with the given arguments in the provided workspace directory.
UpdateEnvironmentVariables(StringDictionary) void
Updates the environment variables for the application prior to execution.
Inherited from CommandLineToolTask
VerbosityForCurrentMsBuildInstance() string
Gets the verbosity that the current MsBuild instance is running at.
Inherited from BaseTask
static