Summary
Contains settings used by
ChocolateyUpgrader.
- Namespace
- Cake
.Common .Tools .Chocolatey .Upgrade - Base Types
-
- object
- ToolSettings
- ChocolateySettings
graph BT
Type-->Base0["ChocolateySettings"]
click Base0 "/api/Cake.Common.Tools.Chocolatey/ChocolateySettings"
Base0-->Base1["ToolSettings"]
click Base1 "/api/Cake.Core.Tooling/ToolSettings"
Base1-->Base2["object"]
Type["ChocolateyUpgradeSettings"]
class Type type-node
Syntax
public sealed class ChocolateyUpgradeSettings : ChocolateySettingsProperties
| Name | Value | Summary |
|---|---|---|
| AcceptLicense | bool |
Gets or sets a value indicating whether to accept license for package.
Inherited from ChocolateySettings
|
| AllowDowngrade | bool |
Gets or sets a value indicating whether to allow downgrade of package.
|
| AllowUnofficial | bool |
Gets or sets a value indicating whether to run in allow unofficial mode.
Inherited from ChocolateySettings
|
| Argument |
Func |
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.
Inherited from ChocolateySettings
|
| Debug | bool |
Gets or sets a value indicating whether to run in debug mode.
Inherited from ChocolateySettings
|
| EnvironmentVariables | IDictionary |
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.
Inherited from ChocolateySettings
|
| FailOnNotInstalled | bool |
Gets or sets a value indicating whether to fail on not installed packages.
|
| FailOnUnfound | bool |
Gets or sets a value indicating whether to fail on unfound packages.
|
| Force | bool |
Gets or sets a value indicating whether to run in forced mode.
Inherited from ChocolateySettings
|
| Forcex86 | bool |
Gets or sets a value indicating whether to force installation of the x86 version of package.
|
| HandleExitCode | Func |
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
|
| IgnoreChecksums | bool |
Gets or sets a value indicating whether to ignore checksums.
|
| IgnoreDependencies | bool |
Gets or sets a value indicating whether to ignore dependencies.
|
| InstallArguments | string |
Gets or sets the install arguments to pass to native installer.
|
| LimitOutput | bool |
Gets or sets a value indicating whether to run in limited output mode.
Inherited from ChocolateySettings
|
| Noop | bool |
Gets or sets a value indicating whether to run in noop mode.
Inherited from ChocolateySettings
|
| NotSilent | bool |
Gets or sets a value indicating whether or not to install silently.
Inherited from ChocolateySettings
|
| 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.
Inherited from ChocolateySettings
|
| PackageParameters | string |
Gets or sets the parameters to pass to the package.
Inherited from ChocolateySettings
|
| Password | string |
Gets or sets the password for authenticated feeds.
|
| PostAction | Action |
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 upgrading to prerelease versions.
This flag is not required when updating prerelease packages that are already installed.
|
| SetupProcessSettings | Action |
Gets or sets a delegate to configure the process settings.
Inherited from ToolSettings
|
| SideBySide | bool |
Gets or sets a value indicating whether to allow side by side installation.
Inherited from ChocolateySettings
|
| SkipPowerShell | bool |
Gets or sets a value indicating whether to skip the PowerShell installation of package.
Inherited from ChocolateySettings
|
| Source | string |
Gets or sets a package sources to use for this command.
Inherited from ChocolateySettings
|
| ToolPath | FilePath |
Gets or sets the tool path.
Inherited from ToolSettings
|
| ToolTimeout | TimeSpan? |
Gets or sets optional timeout for tool execution.
Inherited from ToolSettings
|
| User | string |
Gets or sets the user for authenticated feeds.
|
| Verbose | bool |
Gets or sets a value indicating whether to run in verbose mode.
Inherited from ChocolateySettings
|
| Version | string |
Gets or sets the version of the package to install.
If none specified, the latest will be used.
Inherited from ChocolateySettings
|
| WorkingDirectory | DirectoryPath |
Gets or sets the working directory for the tool process.
Inherited from ToolSettings
|
Extension Methods
| Name | Value | Summary |
|---|---|---|
| Dump |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
| IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
| ThrowIfNull |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ThrowIfNull |
T |
Throws a
System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|