Cake - API - CakeTaskBuilder<TData> Class

Name	Description
TData	The type of the data context.

Name	Summary
CakeTaskBuilder(CakeTask)	Initializes a new instance of the `CakeTaskBuilder<TData>` class.
CakeTaskBuilder(CakeTaskBuilder)	Initializes a new instance of the `CakeTaskBuilder<TData>` class.

Name	Value	Summary
Builder	CakeTaskBuilder	Gets the cake task builder.
Task	ICakeTaskInfo	Gets a read-only representation of the task being configured.

Name	Value	Summary
ContinueOnError<TData>()	CakeTaskBuilder<TData>	Adds an indication to the task that a thrown exception will not halt the script execution. From CakeTaskBuilderOfTExtensions
DeferOnError<TData>()	CakeTaskBuilder<TData>	Defers all exceptions until after all actions for this task have completed. From CakeTaskBuilderOfTExtensions
Description<TData>(string)	CakeTaskBuilder<TData>	Adds a description to the task. From CakeTaskBuilderOfTExtensions
Does<TData>(Action<ICakeContext, TData>)	CakeTaskBuilder<TData>	Adds an action to be executed when the task is invoked. From CakeTaskBuilderOfTExtensions
Does<TData>(Func<ICakeContext, TData, Task>)	CakeTaskBuilder<TData>	Adds an action to be executed when the task is invoked. From CakeTaskBuilderOfTExtensions
DoesForEach<TData, TItem>(Func<TData, ICakeContext, IEnumerable<TItem>>, Action<TData, TItem, ICakeContext>)	CakeTaskBuilder<TData>	Adds an action to be executed foreach item returned by the items function. This method will be executed the first time the task is executed. From CakeTaskBuilderOfTExtensions
DoesForEach<TData, TItem>(IEnumerable<TItem>, Action<TData, TItem, ICakeContext>)	CakeTaskBuilder<TData>	Adds an action to be executed foreach item returned by the items function. This method will be executed the first time the task is executed. From CakeTaskBuilderOfTExtensions
Dump<CakeTaskBuilder<TData>>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
Finally<TData>(Action<ICakeContext, TData>)	CakeTaskBuilder<TData>	Adds a finally handler to be executed after the task have finished executing. From CakeTaskBuilderOfTExtensions
Finally<TData>(Func<ICakeContext, TData, Task>)	CakeTaskBuilder<TData>	Adds a finally handler to be executed after the task have finished executing. From CakeTaskBuilderOfTExtensions
IsDependeeOf<TData>(CakeTaskBuilder<TData>)	CakeTaskBuilder<TData>	Makes the task a dependee of another task. From CakeTaskBuilderOfTExtensions
IsDependeeOf<TData>(string)	CakeTaskBuilder<TData>	Makes the task a dependee of another task. From CakeTaskBuilderOfTExtensions
IsDependentOn<TData>(CakeTaskBuilder)	CakeTaskBuilder<TData>	Creates a dependency between two tasks. From CakeTaskBuilderOfTExtensions
IsDependentOn<TData>(CakeTaskBuilder<TData>)	CakeTaskBuilder<TData>	Creates a dependency between two tasks. From CakeTaskBuilderOfTExtensions
IsDependentOn<TData>(string)	CakeTaskBuilder<TData>	Creates a dependency between two tasks. From CakeTaskBuilderOfTExtensions
IsIn<CakeTaskBuilder<TData>>(CakeTaskBuilder<TData>[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<CakeTaskBuilder<TData>>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
NotNull<CakeTaskBuilder<TData>>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
OnError<TData>(Action<Exception, ICakeContext, TData>)	CakeTaskBuilder<TData>	Adds an error handler to be executed if an exception occurs in the task. From CakeTaskBuilderOfTExtensions
OnError<TData>(Func<Exception, ICakeContext, TData, Task>)	CakeTaskBuilder<TData>	Adds an error handler to be executed if an exception occurs in the task. From CakeTaskBuilderOfTExtensions
ReportError<TData>(Action<Exception>)	CakeTaskBuilder<TData>	Adds an error reporter for the task to be executed when an exception is thrown from the task. This action is invoked before the error handler, but gives no opportunity to recover from the error. From CakeTaskBuilderOfTExtensions
ThrowIfNull<CakeTaskBuilder<TData>>(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<CakeTaskBuilder<TData>>(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
WithCriteria<TData>(Func<ICakeContext, TData, bool>, string)	CakeTaskBuilder<TData>	Adds a criteria that has to be fulfilled for the task to run. The criteria is evaluated when traversal of the graph occurs. From CakeTaskBuilderOfTExtensions
WithCriteria<TData>(Func<ICakeContext, TData, bool>)	CakeTaskBuilder<TData>	Adds a criteria that has to be fulfilled for the task to run. The criteria is evaluated when traversal of the graph occurs. From CakeTaskBuilderOfTExtensions

CakeTaskBuilder<TData> Class

Summary

Syntax

Type Parameters

Constructors

Properties

Extension Methods