IFrostingTask Interface

Summary

A IFrostingTask represents a unit of work.
Namespace
Cake.Frosting
Implementing Types
graph BT Type["IFrostingTask"] class Type type-node Implementing0["AsyncFrostingTask"]-.->Type click Implementing0 "/api/Cake.Frosting/AsyncFrostingTask" Implementing1["AsyncFrostingTask<T>"]-.->Type click Implementing1 "/api/Cake.Frosting/AsyncFrostingTask_1" Implementing2["FrostingTask<T>"]-.->Type click Implementing2 "/api/Cake.Frosting/FrostingTask_1" Implementing3["FrostingTask"]-.->Type click Implementing3 "/api/Cake.Frosting/FrostingTask"

Syntax

public interface IFrostingTask

Properties

Name Value Summary
SkippedMessage string
Gets message used for criteria if ShouldRun(ICakeContext) returns false.

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.Ftp addin
NotNull<IFrostingTask>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues 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
ThrowIfNull<IFrostingTask>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin