Skip to content
Aspire
Docs Try Aspire
Docs Try

Install Aspire CLI

macOS

curl -sSL https://aspire.dev/install.sh | bash

Linux

curl -sSL https://aspire.dev/install.sh | bash

Windows

irm https://aspire.dev/install.ps1 | iex
More installation options

PublishingExtensions Methods

Class Methods 14 members
Extension methods for IReportingStep and IReportingTask to provide direct operations.
FailAsync(IReportingStep, string?, CancellationToken) Section titled FailAsync(IReportingStep, string?, CancellationToken) extension Task<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
step IReportingStep The step to complete.
errorMessage string? optional Optional error message.
cancellationToken CancellationToken optional The cancellation token.
Returns
Task<IReportingStep> The completed step.
FailAsync(IReportingStep, MarkdownString, CancellationToken) Section titled FailAsync(IReportingStep, MarkdownString, CancellationToken) extension Task<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
step IReportingStep The step to complete.
errorMessage MarkdownString The Markdown-formatted error message.
cancellationToken CancellationToken optional The cancellation token.
Returns
Task<IReportingStep> The completed step.
FailAsync(IReportingTask, string?, CancellationToken) Section titled FailAsync(IReportingTask, string?, CancellationToken) extension Task<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
task IReportingTask The task to complete.
errorMessage string? optional Optional error message.
cancellationToken CancellationToken optional The cancellation token.
Returns
Task<IReportingTask> The completed task.
FailAsync(IReportingTask, MarkdownString, CancellationToken) Section titled FailAsync(IReportingTask, MarkdownString, CancellationToken) extension Task<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
task IReportingTask The task to complete.
errorMessage MarkdownString The Markdown-formatted error message.
cancellationToken CancellationToken optional The cancellation token.
Returns
Task<IReportingTask> The completed task.
SucceedAsync(IReportingStep, string?, CancellationToken) Section titled SucceedAsync(IReportingStep, string?, CancellationToken) extension Task<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
step IReportingStep The step to complete.
message string? optional Optional completion message.
cancellationToken CancellationToken optional The cancellation token.
Returns
Task<IReportingStep> The completed step.
SucceedAsync(IReportingStep, MarkdownString, CancellationToken) Section titled SucceedAsync(IReportingStep, MarkdownString, CancellationToken) extension Task<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
step IReportingStep The step to complete.
message MarkdownString The Markdown-formatted completion message.
cancellationToken CancellationToken optional The cancellation token.
Returns
Task<IReportingStep> The completed step.
SucceedAsync(IReportingTask, string?, CancellationToken) Section titled SucceedAsync(IReportingTask, string?, CancellationToken) extension Task<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
task IReportingTask The task to complete.
message string? optional Optional completion message.
cancellationToken CancellationToken optional The cancellation token.
Returns
Task<IReportingTask> The completed task.
SucceedAsync(IReportingTask, MarkdownString, CancellationToken) Section titled SucceedAsync(IReportingTask, MarkdownString, CancellationToken) extension Task<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
task IReportingTask The task to complete.
message MarkdownString The Markdown-formatted completion message.
cancellationToken CancellationToken optional The cancellation token.
Returns
Task<IReportingTask> The completed task.
UpdateStatusAsync(IReportingTask, string, CancellationToken) Section titled UpdateStatusAsync(IReportingTask, string, CancellationToken) extension Task<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
task IReportingTask The task to update.
statusText string The new status text.
cancellationToken CancellationToken optional The cancellation token.
Returns
Task<IReportingTask> The updated task.
UpdateStatusAsync(IReportingTask, MarkdownString, CancellationToken) Section titled UpdateStatusAsync(IReportingTask, MarkdownString, CancellationToken) extension Task<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
task IReportingTask The task to update.
statusText MarkdownString The new Markdown-formatted status text.
cancellationToken CancellationToken optional The cancellation token.
Returns
Task<IReportingTask> The updated task.
WarnAsync(IReportingStep, string?, CancellationToken) Section titled WarnAsync(IReportingStep, string?, CancellationToken) extension Task<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
step IReportingStep The step to complete.
message string? optional Optional completion message.
cancellationToken CancellationToken optional The cancellation token.
Returns
Task<IReportingStep> The completed step.
WarnAsync(IReportingStep, MarkdownString, CancellationToken) Section titled WarnAsync(IReportingStep, MarkdownString, CancellationToken) extension Task<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
step IReportingStep The step to complete.
message MarkdownString The Markdown-formatted warning message.
cancellationToken CancellationToken optional The cancellation token.
Returns
Task<IReportingStep> The completed step.
WarnAsync(IReportingTask, string?, CancellationToken) Section titled WarnAsync(IReportingTask, string?, CancellationToken) extension Task<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
task IReportingTask The task to complete.
message string? optional Optional completion message.
cancellationToken CancellationToken optional The cancellation token.
Returns
Task<IReportingTask> The completed task.
WarnAsync(IReportingTask, MarkdownString, CancellationToken) Section titled WarnAsync(IReportingTask, MarkdownString, CancellationToken) extension Task<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
task IReportingTask The task to complete.
message MarkdownString The Markdown-formatted warning message.
cancellationToken CancellationToken optional The cancellation token.
Returns
Task<IReportingTask> The completed task.
Connect with us

Community

SHA — b06aea4 © Microsoft