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

Base class for all Tfx related tools.

Assembly

Cake.Tfx.dll

Namespace

Cake.Tfx

Base Types

Tool<TSettings>

Derived Types

graph BT Type-->Base0["Tool<TSettings>"] Type["TfxTool<TSettings>"] class Type type-node Derived0["TfxExtensionShareRunner"]-->Type click Derived0 "/api/Cake.Tfx.Extension.Share/TfxExtensionShareRunner" Derived1["TfxExtensionInstallRunner"]-->Type click Derived1 "/api/Cake.Tfx.Extension.Install/TfxExtensionInstallRunner" Derived2["TfxExtensionPublishRunner"]-->Type click Derived2 "/api/Cake.Tfx.Extension.Publish/TfxExtensionPublishRunner" 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