NuGetUpdateSettings Class

Summary

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

Syntax

public sealed class NuGetUpdateSettings : 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
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
Id ICollection<string>
Gets or sets the package ids to update.
MSBuildVersion NuGetMSBuildVersion?
Gets or sets the version of MSBuild to be used with this command. By default the MSBuild in your path is picked, otherwise it defaults to the highest installed version of MSBuild. This setting requires NuGet V3 or later.
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
Prerelease bool
Gets or sets a value indicating whether to allow updating to prerelease versions. This flag is not required when updating prerelease packages that are already installed.
Safe bool
Gets or sets a value indicating whether to look for updates with the highest version available within the same major and minor version as the installed package.
Source ICollection<string>
Gets or sets a list of package 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 amount of output details.
Version string
Gets or sets package version to be used with this command.
WorkingDirectory DirectoryPath
Gets or sets the working directory for the tool process.
Inherited from ToolSettings

Extension Methods

Name Value Summary
Dump<NuGetUpdateSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<NuGetUpdateSettings>(NuGetUpdateSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<NuGetUpdateSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<NuGetUpdateSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<NuGetUpdateSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<NuGetUpdateSettings>(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