IReportingTask Methods

InterfaceMethods4 members

Represents a publishing task, which belongs to a step.

CompleteAsync(string?, CompletionState, CancellationToken)abstractTask

Completes the task with the specified completion message.

public interface IReportingTask
{
    public abstract Task CompleteAsync(
        string? completionMessage = null,
        CompletionState completionState = CompletionState.Completed,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

Parameters

completionMessagestring?optionalOptional completion message that will appear as a dimmed child message.

completionStateCompletionStateoptionalThe completion state of the task.

cancellationTokenCancellationTokenoptionalThe cancellation token.

CompleteAsync(MarkdownString, CompletionState, CancellationToken)abstractTask

Completes the task with a Markdown-formatted completion message.

public interface IReportingTask
{
    public abstract Task CompleteAsync(
        MarkdownString completionMessage,
        CompletionState completionState = CompletionState.Completed,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

Parameters

completionMessageMarkdownStringThe Markdown-formatted completion message that will appear as a dimmed child message.

completionStateCompletionStateoptionalThe completion state of the task.

cancellationTokenCancellationTokenoptionalThe cancellation token.

UpdateAsync(string, CancellationToken)abstractTask

Updates the status text of this task.

public interface IReportingTask
{
    public abstract Task UpdateAsync(
        string statusText,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

Parameters

statusTextstringThe new status text.

cancellationTokenCancellationTokenoptionalThe cancellation token.

UpdateAsync(MarkdownString, CancellationToken)abstractTask

Updates the status text of this task with Markdown-formatted text.

public interface IReportingTask
{
    public abstract Task UpdateAsync(
        MarkdownString statusText,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

Parameters

statusTextMarkdownStringThe new Markdown-formatted status text.

cancellationTokenCancellationTokenoptionalThe cancellation token.