IFrostingTask Interface

Summary

A IFrostingTask represents a unit of work.
graph BT Type["IFrostingTask"] class Type type-node Implementing0["HelloTask"]-.->Type click Implementing0 "/api/global/HelloTask" Implementing1["WorldTask"]-.->Type click Implementing1 "/api/global/WorldTask" Implementing2["FrostingTask<T>"]-.->Type click Implementing2 "/api/Cake.Frosting/FrostingTask_1" Implementing3["DefaultTask"]-.->Type click Implementing3 "/api/global/DefaultTask" Implementing4["DependeeTask"]-.->Type click Implementing4 "/api/global/DependeeTask" Implementing5["FrostingTask"]-.->Type click Implementing5 "/api/Cake.Frosting/FrostingTask" Implementing6["AsyncFrostingTask"]-.->Type click Implementing6 "/api/Cake.Frosting/AsyncFrostingTask" Implementing7["AsyncFrostingTask<T>"]-.->Type click Implementing7 "/api/Cake.Frosting/AsyncFrostingTask_1"

Syntax

public interface IFrostingTask

Methods

Name Value Summary
Finally(ICakeContext) void
The finally handler to be executed after the task have finished executing.
OnError(Exception, ICakeContext) void
The error handler to be executed if an exception occurs in the task.
RunAsync(ICakeContext) Task
Runs the task using the specified context.
ShouldRun(ICakeContext) bool
Gets whether or not the task should be run.

Extension Methods

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