This content is part of a third party extension that is not supported by the Cake project.
For more information about this extension see Cake.Tfx.
Summary
Contains the common settings used by all commands in Tfx.
- Assembly
- Cake
.Tfx .dll - Namespace
- Cake
.Tfx - Base Types
-
- ToolSettings
- Derived Types
graph BT
Type-->Base0["ToolSettings"]
Type["TfxSettings"]
class Type type-node
Derived0["TfxServerSettings"]-->Type
click Derived0 "/api/Cake.Tfx/TfxServerSettings"
Derived1["TfxExtensionCreateSettings"]-->Type
click Derived1 "/api/Cake.Tfx.Extension.Create/TfxExtensionCreateSettings"
Syntax
public abstract class TfxSettings : ToolSettingsConstructors
| Name | Summary |
|---|---|
| TfxSettings |
Properties
| Name | Value | Summary |
|---|---|---|
| ExtensionId | string |
Gets or sets a value to use as the extension ID instead of what is specified in the manifest.
|
| NoPrompt | bool |
Gets or sets a value indicating whether to not prompt the user for input (instead, raise an error).
|
| Output | Nullable |
Gets or sets a value indicating the output type to be used for commands
|
| Publisher | string |
Gets or sets a value to use as the publisher ID instead of what is specified in the manifest.
|
| Save | bool |
Gets or sets a value indicating whether to save arguments for the next time a command in this command group is run.
|
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 Extensions
Requires the Cake.Ftp addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From IssuesArgumentChecks
Requires the Cake.Issues 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
|
| ThrowIfNull |
T |
Throws a
System.ArgumentNullException 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
|
| To |
string |
Returns the string value or a
Not set> markup suitable for Spectre.Console.
From StringExtensions
Requires the Cake.Issues addin
|