Summary
A
IFrostingTask represents a unit of work.
- Namespace
- Cake
.Frosting - Implementing Types
graph BT
Type["IFrostingTask"]
class Type type-node
Implementing0["FrostingTask"]-.->Type
click Implementing0 "/api/Cake.Frosting/FrostingTask"
Implementing1["FinallyTask"]-.->Type
click Implementing1 "/api/Cake.Frosting.Tests/FinallyTask"
Implementing2["CleanTask"]-.->Type
click Implementing2 "/api/Cake.Frosting.Tests/CleanTask"
Implementing3["DummyTask3"]-.->Type
click Implementing3 "/api/Cake.Frosting.Tests/DummyTask3"
Implementing4["DependeeTask"]-.->Type
click Implementing4 "/api/Cake.Frosting.Tests/DependeeTask"
Implementing5["ThrowingTask"]-.->Type
click Implementing5 "/api/Cake.Frosting.Tests/ThrowingTask"
Implementing6["DummyTask"]-.->Type
click Implementing6 "/api/Cake.Frosting.Tests/DummyTask"
Implementing7["FrostingTask<T>"]-.->Type
click Implementing7 "/api/Cake.Frosting/FrostingTask_1"
Implementing8["InvalidDependencyTask"]-.->Type
click Implementing8 "/api/Cake.Frosting.Tests/InvalidDependencyTask"
Implementing9["UnitTestsTask"]-.->Type
click Implementing9 "/api/Cake.Frosting.Tests/UnitTestsTask"
Implementing10["OnErrorRunCompletedTask"]-.->Type
click Implementing10 "/api/Cake.Frosting.Tests/OnErrorRunCompletedTask"
Implementing11["BuildTask"]-.->Type
click Implementing11 "/api/Cake.Frosting.Tests/BuildTask"
Implementing12["AsyncFrostingTask<T>"]-.->Type
click Implementing12 "/api/Cake.Frosting/AsyncFrostingTask_1"
Implementing13["OnErrorRunFailedTask"]-.->Type
click Implementing13 "/api/Cake.Frosting.Tests/OnErrorRunFailedTask"
Implementing14["DummyTask2"]-.->Type
click Implementing14 "/api/Cake.Frosting.Tests/DummyTask2"
Implementing15["OnErrorRunAsyncFailedTask"]-.->Type
click Implementing15 "/api/Cake.Frosting.Tests/OnErrorRunAsyncFailedTask"
Implementing16["ContinueOnErrorTask"]-.->Type
click Implementing16 "/api/Cake.Frosting.Tests/ContinueOnErrorTask"
Implementing17["AsyncFrostingTask"]-.->Type
click Implementing17 "/api/Cake.Frosting/AsyncFrostingTask"
Syntax
public interface IFrostingTaskProperties
| Name | Value | Summary |
|---|---|---|
| SkippedMessage | string |
Gets message used for criteria if
ShouldRun(ICakeContext) returns false.
|
Methods
| Name | Value | Summary |
|---|---|---|
| Finally |
void |
The finally handler to be executed after the task have finished executing.
|
| OnError |
void |
The error handler to be executed if an exception occurs in the task.
|
| RunAsync |
Task |
Runs the task using the specified context.
|
| ShouldRun |
bool |
Gets whether or not the task should be run.
|
Extension Methods
| Name | Value | Summary |
|---|---|---|
| Dump |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
| IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
| ThrowIfNull |
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 |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|
| To |
string |
Returns the string value or a
Not set> markup suitable for Spectre.Console.
From StringExtensions
Requires the Cake.Issues addin
|