TfxTool<TSettings> Class

Summary

Base class for all Tfx related tools.
Assembly
Cake.Tfx.dll
Namespace
Cake.Tfx
Base Types
Derived Types
graph BT Type-->Base0["Tool<TSettings>"] Type["TfxTool<TSettings>"] class Type type-node Derived0["TfxExtensionInstallRunner"]-->Type click Derived0 "/api/Cake.Tfx.Extension.Install/TfxExtensionInstallRunner" Derived1["TfxExtensionPublishRunner"]-->Type click Derived1 "/api/Cake.Tfx.Extension.Publish/TfxExtensionPublishRunner" Derived2["TfxExtensionShareRunner"]-->Type click Derived2 "/api/Cake.Tfx.Extension.Share/TfxExtensionShareRunner" Derived3["TfxExtensionCreateRunner"]-->Type click Derived3 "/api/Cake.Tfx.Extension.Create/TfxExtensionCreateRunner"

Syntax

public abstract class TfxTool<TSettings> : Tool<TSettings> where TSettings : TfxSettings

Type Parameters

Name Description
TSettings The settings type.

Constructors

Name Summary
TfxTool(IFileSystem, ICakeEnvironment, IProcessRunner, IToolLocator) Initializes a new instance of the TfxTool<TSettings> class.

Methods

Name Value Summary
GetToolExecutableNames() IEnumerable<string>
Gets the possible names of the tool executable.
GetToolName() string
Gets the name of the tool.
RunTfx<TBuilder>(TSettings, TBuilder) void
Runs the TFX tool with the specified settings.

Extension Methods

Name Value Summary
Dump<TfxTool<TSettings>>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<TfxTool<TSettings>>(TfxTool<TSettings>[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<TfxTool<TSettings>>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<TfxTool<TSettings>>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<TfxTool<TSettings>>(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
ThrowIfNull<TfxTool<TSettings>>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin