Summary
Base class for a Frosting task using a custom context.
- Namespace
- Cake
.Frosting - Interfaces
- Base Types
-
- object
- Derived Types
graph BT
Type-->Base0["object"]
Type-.->Interface0["IFrostingTask"]
click Interface0 "/api/Cake.Frosting/IFrostingTask"
Type["FrostingTask<T>"]
class Type type-node
Derived0["FrostingTask"]-->Type
click Derived0 "/api/Cake.Frosting/FrostingTask"
Syntax
public abstract class FrostingTask<T> : IFrostingTask where T : ICakeContextType Parameters
| Name | Description |
|---|---|
| T | The context type. |
Methods
| Name | Value | Summary |
|---|---|---|
| Finally |
void |
The finally handler to be executed using the specified context after the task has finished executing.
|
| OnError |
void |
The error handler to be executed using the specified context if an exception occurs in the task.
|
| Run |
void |
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
|