TfxSettings Class

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["TfxExtensionCreateSettings"]-->Type click Derived0 "/api/Cake.Tfx.Extension.Create/TfxExtensionCreateSettings" Derived1["TfxServerSettings"]-->Type click Derived1 "/api/Cake.Tfx/TfxServerSettings"

Syntax

public abstract class TfxSettings : ToolSettings

Constructors

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<TfxOutputType>
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<TfxSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<TfxSettings>(TfxSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<TfxSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<TfxSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<TfxSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<TfxSettings>(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