PublishingExtensions Methods

ClassMethods14 members

Extension methods for IReportingStep and IReportingTask to provide direct operations.

FailAsync(IReportingStep, string?, CancellationToken)extensionTask<IReportingStep>

Completes a publishing step with an error.

public static class PublishingExtensions
{
    public static Task<IReportingStep> FailAsync(
        this IReportingStep step,
        string? errorMessage = null,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

PublishingExtensions.cs

Parameters

stepIReportingStepThe step to complete.

errorMessagestring?optionalOptional error message.

cancellationTokenCancellationTokenoptionalThe cancellation token.

Returns

Task<IReportingStep>The completed step.

FailAsync(IReportingStep, MarkdownString, CancellationToken)extensionTask<IReportingStep>

Completes a publishing step with an error and Markdown-formatted message.

public static class PublishingExtensions
{
    public static Task<IReportingStep> FailAsync(
        this IReportingStep step,
        MarkdownString errorMessage,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

PublishingExtensions.cs

Parameters

stepIReportingStepThe step to complete.

errorMessageMarkdownStringThe Markdown-formatted error message.

cancellationTokenCancellationTokenoptionalThe cancellation token.

Returns

Task<IReportingStep>The completed step.

FailAsync(IReportingTask, string?, CancellationToken)extensionTask<IReportingTask>

Completes a publishing task with an error.

public static class PublishingExtensions
{
    public static Task<IReportingTask> FailAsync(
        this IReportingTask task,
        string? errorMessage = null,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

PublishingExtensions.cs

Parameters

taskIReportingTaskThe task to complete.

errorMessagestring?optionalOptional error message.

cancellationTokenCancellationTokenoptionalThe cancellation token.

Returns

Task<IReportingTask>The completed task.

FailAsync(IReportingTask, MarkdownString, CancellationToken)extensionTask<IReportingTask>

Completes a publishing task with an error and Markdown-formatted message.

public static class PublishingExtensions
{
    public static Task<IReportingTask> FailAsync(
        this IReportingTask task,
        MarkdownString errorMessage,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

PublishingExtensions.cs

Parameters

taskIReportingTaskThe task to complete.

errorMessageMarkdownStringThe Markdown-formatted error message.

cancellationTokenCancellationTokenoptionalThe cancellation token.

Returns

Task<IReportingTask>The completed task.

SucceedAsync(IReportingStep, string?, CancellationToken)extensionTask<IReportingStep>

Completes a publishing step successfully.

public static class PublishingExtensions
{
    public static Task<IReportingStep> SucceedAsync(
        this IReportingStep step,
        string? message = null,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

PublishingExtensions.cs

Parameters

stepIReportingStepThe step to complete.

messagestring?optionalOptional completion message.

cancellationTokenCancellationTokenoptionalThe cancellation token.

Returns

Task<IReportingStep>The completed step.

SucceedAsync(IReportingStep, MarkdownString, CancellationToken)extensionTask<IReportingStep>

Completes a publishing step successfully with a Markdown-formatted message.

public static class PublishingExtensions
{
    public static Task<IReportingStep> SucceedAsync(
        this IReportingStep step,
        MarkdownString message,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

PublishingExtensions.cs

Parameters

stepIReportingStepThe step to complete.

messageMarkdownStringThe Markdown-formatted completion message.

cancellationTokenCancellationTokenoptionalThe cancellation token.

Returns

Task<IReportingStep>The completed step.

SucceedAsync(IReportingTask, string?, CancellationToken)extensionTask<IReportingTask>

Completes a publishing task successfully.

public static class PublishingExtensions
{
    public static Task<IReportingTask> SucceedAsync(
        this IReportingTask task,
        string? message = null,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

PublishingExtensions.cs

Parameters

taskIReportingTaskThe task to complete.

messagestring?optionalOptional completion message.

cancellationTokenCancellationTokenoptionalThe cancellation token.

Returns

Task<IReportingTask>The completed task.

SucceedAsync(IReportingTask, MarkdownString, CancellationToken)extensionTask<IReportingTask>

Completes a publishing task successfully with a Markdown-formatted message.

public static class PublishingExtensions
{
    public static Task<IReportingTask> SucceedAsync(
        this IReportingTask task,
        MarkdownString message,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

PublishingExtensions.cs

Parameters

taskIReportingTaskThe task to complete.

messageMarkdownStringThe Markdown-formatted completion message.

cancellationTokenCancellationTokenoptionalThe cancellation token.

Returns

Task<IReportingTask>The completed task.

UpdateStatusAsync(IReportingTask, string, CancellationToken)extensionTask<IReportingTask>

Updates the status text of a publishing task.

public static class PublishingExtensions
{
    public static Task<IReportingTask> UpdateStatusAsync(
        this IReportingTask task,
        string statusText,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

PublishingExtensions.cs

Parameters

taskIReportingTaskThe task to update.

statusTextstringThe new status text.

cancellationTokenCancellationTokenoptionalThe cancellation token.

Returns

Task<IReportingTask>The updated task.

UpdateStatusAsync(IReportingTask, MarkdownString, CancellationToken)extensionTask<IReportingTask>

Updates the status text of a publishing task with Markdown-formatted text.

public static class PublishingExtensions
{
    public static Task<IReportingTask> UpdateStatusAsync(
        this IReportingTask task,
        MarkdownString statusText,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

PublishingExtensions.cs

Parameters

taskIReportingTaskThe task to update.

statusTextMarkdownStringThe new Markdown-formatted status text.

cancellationTokenCancellationTokenoptionalThe cancellation token.

Returns

Task<IReportingTask>The updated task.

WarnAsync(IReportingStep, string?, CancellationToken)extensionTask<IReportingStep>

Completes a publishing step with a warning.

public static class PublishingExtensions
{
    public static Task<IReportingStep> WarnAsync(
        this IReportingStep step,
        string? message = null,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

PublishingExtensions.cs

Parameters

stepIReportingStepThe step to complete.

messagestring?optionalOptional completion message.

cancellationTokenCancellationTokenoptionalThe cancellation token.

Returns

Task<IReportingStep>The completed step.

WarnAsync(IReportingStep, MarkdownString, CancellationToken)extensionTask<IReportingStep>

Completes a publishing step with a warning and Markdown-formatted message.

public static class PublishingExtensions
{
    public static Task<IReportingStep> WarnAsync(
        this IReportingStep step,
        MarkdownString message,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

PublishingExtensions.cs

Parameters

stepIReportingStepThe step to complete.

messageMarkdownStringThe Markdown-formatted warning message.

cancellationTokenCancellationTokenoptionalThe cancellation token.

Returns

Task<IReportingStep>The completed step.

WarnAsync(IReportingTask, string?, CancellationToken)extensionTask<IReportingTask>

Completes a publishing task with a warning.

public static class PublishingExtensions
{
    public static Task<IReportingTask> WarnAsync(
        this IReportingTask task,
        string? message = null,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

PublishingExtensions.cs

Parameters

taskIReportingTaskThe task to complete.

messagestring?optionalOptional completion message.

cancellationTokenCancellationTokenoptionalThe cancellation token.

Returns

Task<IReportingTask>The completed task.

WarnAsync(IReportingTask, MarkdownString, CancellationToken)extensionTask<IReportingTask>

Completes a publishing task with a warning and Markdown-formatted message.

public static class PublishingExtensions
{
    public static Task<IReportingTask> WarnAsync(
        this IReportingTask task,
        MarkdownString message,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

PublishingExtensions.cs

Parameters

taskIReportingTaskThe task to complete.

messageMarkdownStringThe Markdown-formatted warning message.

cancellationTokenCancellationTokenoptionalThe cancellation token.

Returns

Task<IReportingTask>The completed task.