NuGetInstallSettings Class

Summary

Contains settings used by NuGetInstaller.
Namespace
Cake.Common.Tools.NuGet.Install
Base Types
graph BT Type-->Base0["ToolSettings"] click Base0 "/api/Cake.Core.Tooling/ToolSettings" Base0-->Base1["object"] Type["NuGetInstallSettings"] class Type type-node

Syntax

public sealed class NuGetInstallSettings : ToolSettings

Properties

Name Value Summary
ArgumentCustomization Func<ProcessArgumentBuilder, ProcessArgumentBuilder>
Gets or sets the argument customization. Argument customization is a way that lets you add, replace or reuse arguments passed to a tool. This allows you to support new tool arguments, customize arguments or address potential argument issues.
Inherited from ToolSettings
ConfigFile FilePath
Gets or sets the NuGet configuration file. If not specified, the file %AppData%\NuGet\NuGet.config is used as the configuration file.
DisableParallelProcessing bool
Gets or sets a value indicating whether to disable parallel processing of packages for this command. Disable parallel processing of packages for this command.
EnvironmentVariables IDictionary<string, string>
Gets or sets search paths for files, directories for temporary files, application-specific options, and other similar information.
Inherited from ToolSettings
ExcludeVersion bool
Gets or sets a value indicating whether to exclude the version number from the package folder.
FallbackSource ICollection<string>
Gets or sets a list of packages sources to use as fallbacks for this command. This setting requires NuGet V3 or later.
HandleExitCode Func<int, bool>
Gets or sets whether the exit code from the tool process causes an exception to be thrown.

If the delegate is null (the default) or returns false, then an exception is thrown upon a non-zero exit code.

If the delegate returns true then no exception is thrown.

This can be useful when the exit code should be ignored, or if there is a desire to apply logic that is conditional on the exit code value.

Inherited from ToolSettings
NoCache bool
Gets or sets a value indicating whether or not to use the machine cache as the first package source.
NonInteractive bool
Gets or sets a value indicating whether or not NuGet suppresses prompts for user input or confirmations.
NoWorkingDirectory bool
Gets or sets a value indicating whether or not to opt out of using an explicit working directory for the process.
Inherited from ToolSettings
OutputDirectory DirectoryPath
Gets or sets the directory in which packages will be installed. If none is specified, the current directory will be used.
PostAction Action<IProcess>
Gets or sets a delegate which is executed after the process was started.
Inherited from ToolSettings
Prerelease bool
Gets or sets a value indicating whether to allow installation of prerelease packages. This flag is not required when restoring packages by installing from packages.config.
RequireConsent bool
Gets or sets a value indicating whether to check if package install consent is granted before installing a package.
SetupProcessSettings Action<ProcessSettings>
Gets or sets a delegate to configure the process settings.
Inherited from ToolSettings
SolutionDirectory DirectoryPath
Gets or sets the solution directory path for package restore.
Source ICollection<string>
Gets or sets a list of packages sources to use for this command.
ToolPath FilePath
Gets or sets the tool path.
Inherited from ToolSettings
ToolTimeout TimeSpan?
Gets or sets optional timeout for tool execution.
Inherited from ToolSettings
Verbosity NuGetVerbosity?
Gets or sets the output verbosity.
Version string
Gets or sets the version of the package to install. If none specified, the latest will be used.
WorkingDirectory DirectoryPath
Gets or sets the working directory for the tool process.
Inherited from ToolSettings

Extension Methods

Name Value Summary
Dump<NuGetInstallSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<NuGetInstallSettings>(NuGetInstallSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<NuGetInstallSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<NuGetInstallSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
ThrowIfNull<NuGetInstallSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<NuGetInstallSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin