AsyncFrostingTask<T> Class

Summary

Base class for an asynchronous 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["AsyncFrostingTask<T>"] class Type type-node Derived0["OnErrorRunAsyncFailedTask"]-->Type click Derived0 "/api/Cake.Frosting.Tests/OnErrorRunAsyncFailedTask" Derived1["AsyncFrostingTask"]-->Type click Derived1 "/api/Cake.Frosting/AsyncFrostingTask"

Syntax

public abstract class AsyncFrostingTask<T> : IFrostingTask where T : ICakeContext

Type Parameters

Name Description
T The context type.

Methods

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

Extension Methods

Name Value Summary
Dump<AsyncFrostingTask<T>>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<AsyncFrostingTask<T>>(AsyncFrostingTask<T>[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<AsyncFrostingTask<T>>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<AsyncFrostingTask<T>>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<AsyncFrostingTask<T>>(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<AsyncFrostingTask<T>>(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
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin

See Also