Summary
Represents the Cake engine.
- Namespace
- Cake
.Core - Implementing Types
graph BT
Type["ICakeEngine"]
class Type type-node
Implementing0["CakeEngine"]-.->Type
click Implementing0 "/api/Cake.Core/CakeEngine"
Syntax
public interface ICakeEngineEvents
| Name | Type | Summary |
|---|---|---|
| AfterSetup | EventHandler |
Raised at the end of setup before any tasks are run.
|
| AfterTaskSetup | EventHandler |
Raised at the end of task setup before each task is run.
|
| AfterTaskTeardown | EventHandler |
Raised at the end of task teardown after each task has been run.
|
| AfterTeardown | EventHandler |
Raised at the end of teardown after all other tasks have been run.
|
| BeforeSetup | EventHandler |
Raised at the start of setup before any tasks are run.
|
| BeforeTaskSetup | EventHandler |
Raised at the start of task setup before each task is run.
|
| BeforeTaskTeardown | EventHandler |
Raised at the start of task teardown after each task has been run.
|
| BeforeTeardown | EventHandler |
Raised at the start of teardown after all other tasks have been run.
|
Properties
| Name | Value | Summary |
|---|---|---|
| Tasks | IReadOnlyList |
Gets all registered tasks.
|
Methods
| Name | Value | Summary |
|---|---|---|
| RegisterSetupAction |
void |
Allows registration of an action that's executed before any tasks are run.
If setup fails, no tasks will be executed but teardown will be performed.
|
| RegisterSetupAction |
void |
Allows registration of an action that's executed before any tasks are run.
If setup fails, no tasks will be executed but teardown will be performed.
|
| RegisterTask |
CakeTaskBuilder |
Creates and registers a new Cake task.
|
| Register |
void |
Allows registration of an action that's executed before each task is run.
If the task setup fails, the task will not be executed but the task's teardown will be performed.
|
| Register |
void |
Allows registration of an action that's executed before each task is run.
If the task setup fails, the task will not be executed but the task's teardown will be performed.
|
| Register |
void |
Allows registration of an action that's executed after each task has been run.
If a task setup action or a task fails with or without recovery, the specified task teardown action will still be executed.
|
| Register |
void |
Allows registration of an action that's executed after each task has been run.
If a task setup action or a task fails with or without recovery, the specified task teardown action will still be executed.
|
| Register |
void |
Allows registration of an action that's executed after all other tasks have been run.
If a setup action or a task fails with or without recovery, the specified teardown action will still be executed.
|
| Register |
void |
Allows registration of an action that's executed after all other tasks have been run.
If a setup action or a task fails with or without recovery, the specified teardown action will still be executed.
|
| RunTargetAsync |
Task |
Runs the specified target using the specified
IExecutionStrategy.
|
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 Extensions
Requires the Cake.Ftp addin
|
| NotNull |
void |
From IssuesArgumentChecks
Requires the Cake.Issues 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 |
From StringExtensions
Requires the Cake.Issues addin
|