ChocolateyUninstallSettings Class

Summary

Contains settings used by ChocolateyUninstaller.
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["ChocolateyUninstallSettings"] class Type type-node

Syntax

public sealed class ChocolateyUninstallSettings : ChocolateySettings

Properties

Name Value Summary
AcceptLicense bool
Gets or sets a value indicating whether to accept license for package.
Inherited from ChocolateySettings
AllowUnofficial bool
Gets or sets a value indicating whether to run in allow unofficial mode.
Inherited from ChocolateySettings
AllVersions bool
Gets or sets a value indicating whether to uninstall all versions.
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.
Inherited from ChocolateySettings
Debug bool
Gets or sets a value indicating whether to run in debug mode.
Inherited from ChocolateySettings
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.
Inherited from ChocolateySettings
FailOnAutoUninstaller bool
Gets or sets a value indicating whether to fail the package uninstall if the auto uninstaller reports and error.
FailOnStandardError bool
Gets or sets a value indicating whether it fails on standard error output.
Force bool
Gets or sets a value indicating whether to run in forced mode.
Inherited from ChocolateySettings
ForceDependencies bool
Gets or sets a value indicating whether to force dependencies.
GlobalArguments bool
Gets or sets a value indicating whether install arguments should be applied to dependent packages.
GlobalPackageParameters bool
Gets or sets a value indicating whether global parameters are passed to the package.
IgnoreAutoUninstaller bool
Gets or sets a value indicating whether to not fail the package if auto uninstaller reports an error.
IgnorePackageExitCodes bool
Gets or sets a value indicating whether to Exit with a 0 for success and 1 for non-success no matter what package scripts provide for exit codes.
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
SideBySide bool
Gets or sets a value indicating whether to allow side by side installation.
Inherited from ChocolateySettings
SkipAutoUninstaller bool
Gets or sets a value indicating whether to skip auto uninstaller service when uninstalling.
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
UninstallArguments string
Gets or sets the uninstall arguments to pass to native installer.
UseAutoUninstaller bool
Gets or sets a value indicating whether to use auto uninstaller service when uninstalling.
UsePackageExitCodes bool
Gets or sets a value indicating whether to use package exit codes.
UseSystemPowershell bool
Gets or sets a value indicating whether an external process is used instead of built in PowerShell host.
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<ChocolateyUninstallSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<ChocolateyUninstallSettings>(ChocolateyUninstallSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<ChocolateyUninstallSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<ChocolateyUninstallSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<ChocolateyUninstallSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<ChocolateyUninstallSettings>(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