Summary
Contains settings used by
ChocolateySources.
- Namespace
- Cake
.Common .Tools .Chocolatey .Sources - Base Types
-
- object
- ToolSettings
graph BT
Type-->Base0["ToolSettings"]
click Base0 "/api/Cake.Core.Tooling/ToolSettings"
Base0-->Base1["object"]
Type["ChocolateySourcesSettings"]
class Type type-node
Syntax
public sealed class ChocolateySourcesSettings : ToolSettingsProperties
| Name | Value | Summary |
|---|---|---|
| AllowUnofficial | bool |
Gets or sets a value indicating whether to run in allow unofficial mode.
|
| 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.
|
| Debug | bool |
Gets or sets a value indicating whether to run in debug mode.
|
| 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.
|
| 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.
|
| 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
|
| Password | string |
Gets or sets the (optional) password.
|
| Priority | int |
Gets or sets the (optional) priority.
|
| ToolPath | FilePath |
Gets or sets the tool path.
Inherited from ToolSettings
|
| ToolTimeout | TimeSpan? |
Gets or sets optional timeout for tool execution.
Inherited from ToolSettings
|
| UserName | string |
Gets or sets the (optional) user name.
|
| Verbose | bool |
Gets or sets a value indicating whether to run in verbose mode.
|
| 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
|