ChocolateySettings Class

Summary

Contains settings used by ChocolateySettings.
graph BT Type-->Base0["ToolSettings"] click Base0 "/api/Cake.Core.Tooling/ToolSettings" Base0-->Base1["object"] Type["ChocolateySettings"] class Type type-node Derived0["ChocolateyInstallSettings"]-->Type click Derived0 "/api/Cake.Common.Tools.Chocolatey.Install/ChocolateyInstallSettings" Derived1["ChocolateyUpgradeSettings"]-->Type click Derived1 "/api/Cake.Common.Tools.Chocolatey.Upgrade/ChocolateyUpgradeSettings" Derived2["ChocolateyUninstallSettings"]-->Type click Derived2 "/api/Cake.Common.Tools.Chocolatey.Uninstall/ChocolateyUninstallSettings" Derived3["ChocolateyNewSettings"]-->Type click Derived3 "/api/Cake.Common.Tools.Chocolatey.New/ChocolateyNewSettings" Derived4["ChocolateyDownloadSettings"]-->Type click Derived4 "/api/Cake.Common.Tools.Chocolatey.Download/ChocolateyDownloadSettings"

Syntax

public class ChocolateySettings : ToolSettings

Properties

Name Value Summary
AcceptLicense bool
Gets or sets a value indicating whether to accept license for package.
AllowUnofficial bool
Gets or sets a value indicating whether to run in allow unofficial mode.
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
CacheLocation string
Gets or sets the location of the download cache.
Debug bool
Gets or sets a value indicating whether to run in debug mode.
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
ExecutionTimeout int
Gets or sets the execution timeout value.
Force bool
Gets or sets a value indicating whether to run in forced mode.
LimitOutput bool
Gets or sets a value indicating whether to run in limited output mode.
Noop bool
Gets or sets a value indicating whether to run in noop mode.
NotSilent bool
Gets or sets a value indicating whether or not to install silently.
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
OverrideArguments bool
Gets or sets a value indicating whether to override the passed arguments.
PackageParameters string
Gets or sets the parameters to pass to the package.
SideBySide bool
Gets or sets a value indicating whether to allow side by side installation.
SkipPowerShell bool
Gets or sets a value indicating whether to skip the PowerShell installation of package.
Source string
Gets or sets a 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
Verbose bool
Gets or sets a value indicating whether to run in verbose mode.
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<ChocolateySettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<ChocolateySettings>(ChocolateySettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<ChocolateySettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<ChocolateySettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<ChocolateySettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<ChocolateySettings>(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