NetlifyTool<TSettings> Class

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.Netlify.

Summary

Base class for all Netlify-CLI tools.

Assembly

Cake.Netlify.dll

Namespace

Base Types

Tool<TSettings>

Derived Types

NetlifyDeployRunner

graph BT Type-->Base0["Tool<TSettings>"] Type["NetlifyTool<TSettings>"] class Type type-node Derived0["NetlifyDeployRunner"]-->Type click Derived0 "/api/Cake.Netlify.Deploy/NetlifyDeployRunner"

Syntax

public abstract class NetlifyTool<TSettings> : Tool<TSettings> where TSettings : NetlifySettings

Type Parameters

Name	Description
TSettings

Constructors

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

Methods

Name	Value	Summary
GetAlternativeToolPaths(TSettings)	IEnumerable<FilePath>	Gets alternative file paths which the tool may exist.
GetToolExecutableNames()	IEnumerable<string>	Gets the possible names of the tool executable.
GetToolName()	string	Gets the name of the tool.

Extension Methods

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