CakeTask Class

Summary

A CakeTask represents a unit of work.

Namespace

Interfaces

ICakeTaskInfo

Base Types

object

graph BT Type-->Base0["object"] Type-.->Interface0["ICakeTaskInfo"] click Interface0 "/api/Cake.Core/ICakeTaskInfo" Type["CakeTask"] class Type type-node

Syntax

public sealed class CakeTask : ICakeTaskInfo

Constructors

Name	Summary
CakeTask(string)	Initializes a new instance of the `CakeTask` class.

Properties

Name	Value	Summary
Actions	List<Func<ICakeContext, Task>>	Gets the task's actions.
Criterias	List<CakeTaskCriteria>	Gets the task's criterias.
DeferExceptions	bool	Gets or sets a value indicating whether gets the task's state if it will defer exceptions until the end of the task.
DelayedActions	Queue<Action<ICakeContext>>	Gets the task's actions that are run at execution time to additionally populate `Actions`.
Dependees	List<CakeTaskDependency>	Gets the tasks that the task want to be a dependency of.
Dependencies	List<CakeTaskDependency>	Gets the task's dependencies.
Description	string	Gets the description of the task.
ErrorHandler	Func<Exception, ICakeContext, Task>	Gets or sets the error handler.
ErrorReporter	Func<Exception, Task>	Gets or sets the error reporter.
FinallyHandler	Func<ICakeContext, Task>	Gets or sets the finally handler.
Name	string	Gets the name of the task.

Methods

Name	Value	Summary
Execute(ICakeContext)	Task	Executes the task using the specified context.

Extension Methods

Name	Value	Summary
AddAction(Func<ICakeContext, Task>)	void	Adds the action to the task's actions. From CakeTaskExtensions
AddCriteria(Func<ICakeContext, bool>, string)	void	Adds to the task's criteria. From CakeTaskExtensions
AddDelayedAction(Action<ICakeContext>)	void	Adds the action to the task's delayed actions. From CakeTaskExtensions
AddDependee(string, bool)	void	Adds the dependee to the task's dependees. From CakeTaskExtensions
AddDependency(string, bool)	void	Adds the dependency to the task's dependencies. From CakeTaskExtensions
Dump<CakeTask>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<CakeTask>(CakeTask[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<CakeTask>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
NotNull<CakeTask>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
SetDeferExceptions(bool)	void	Sets the task's defer exceptions state. From CakeTaskExtensions
SetErrorHandler(Action<Exception, ICakeContext>)	void	Sets the task's error handler. From CakeTaskExtensions
SetErrorHandler(Func<Exception, ICakeContext, Task>)	void	Sets the task's error handler. From CakeTaskExtensions
SetErrorReporter(Action<Exception>)	void	Sets the task's error reporter. From CakeTaskExtensions
SetErrorReporter(Func<Exception, Task>)	void	Sets the task's error reporter. From CakeTaskExtensions
SetFinallyHandler(Action)	void	Sets the task's finally handler. From CakeTaskExtensions
SetFinallyHandler(Action<ICakeContext>)	void	Sets the task's finally handler. From CakeTaskExtensions
SetFinallyHandler(Func<ICakeContext, Task>)	void	Sets the task's finally handler. From CakeTaskExtensions
SetFinallyHandler(Func<Task>)	void	Sets the task's finally handler. From CakeTaskExtensions
ThrowIfNull<CakeTask>(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<CakeTask>(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