ChocolateyDownloadSettings Class

Summary

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

Syntax

public sealed class ChocolateyDownloadSettings : 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
AppendUseOriginalLocation bool
Gets or sets a value indicating whether the -useOriginalLocation parameter will be passed to any Install-ChocolateyPackage call in the package and avoiding downloading of resources when Internalize is set. Overrides the global internalizeAppendUseOriginalLocation feature. By default set to false. Requires Chocolatey business edition and Chocolatey v0.10.1 or newer.
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
DownloadLocation string
Gets or sets the location where resources should be downloaded to when ResourcesLocation is set. null or System.String.Empty if ResourcesLocation should be used. By default ResourcesLocation is used. Requires Chocolatey business edition.
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
Force bool
Gets or sets a value indicating whether to run in forced mode.
Inherited from ChocolateySettings
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
IgnoreDependencies bool
Gets or sets a value indicating whether to ignore dependencies. Requires Chocolatey licensed edition.
Internalize bool
Gets or sets a value indicating whether all external resources should be downloaded and the package be recompiled to use the local resources instead. Requires Chocolatey business edition.
InternalizeAllUrls bool
Gets or sets a value indicating whether all URLs, not only from known helpers, should be internalized. Requires Chocolatey business edition (Licensed version 1.11.1+).
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
OutputDirectory DirectoryPath
Gets or sets the directory for the downloaded Chocolatey packages. By default the current working directory is used.
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.
Prerelease bool
Gets or sets a value indicating whether to allow downloading of prerelease packages.
ResourcesLocation string
Gets or sets the location for downloaded resource when Internalize is set. null or System.String.Empty if downloaded resources should be embedded in the package. Can be a file share or an internal URL location. When it is a file share, it will attempt to download to that location. When it is an internal url, it will download locally and give further instructions where it should be uploaded to match package edits. By default resources are embedded in the package. Requires Chocolatey business edition.
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<ChocolateyDownloadSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<ChocolateyDownloadSettings>(ChocolateyDownloadSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<ChocolateyDownloadSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<ChocolateyDownloadSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<ChocolateyDownloadSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<ChocolateyDownloadSettings>(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