IReportingStep Methods

1. Docs
2. /Reference
3. /Search C# APIs
4. /Aspire.Hosting
5. /IReportingStep
6. /Methods

InterfaceMethods7 members

Represents a publishing step, which can contain multiple tasks.

CompleteAsync(string, CompletionState, CancellationToken)abstractTask

Completes the step with the specified completion text and state.

public interface IReportingStep
{
    public abstract Task CompleteAsync(
        string completionText,
        CompletionState completionState = CompletionState.Completed,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

Parameters

completionTextstringThe completion text for the step.

completionStateCompletionStateoptionalThe completion state for the step.

cancellationTokenCancellationTokenoptionalThe cancellation token.

CompleteAsync(MarkdownString, CompletionState, CancellationToken)abstractTask

Completes the step with Markdown-formatted completion text and the specified state.

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

Parameters

completionTextMarkdownStringThe Markdown-formatted completion text for the step.

completionStateCompletionStateoptionalThe completion state for the step.

cancellationTokenCancellationTokenoptionalThe cancellation token.

CreateTaskAsync(string, CancellationToken)abstractTask<IReportingTask>

Creates a new task within this step.

public interface IReportingStep
{
    public abstract Task<IReportingTask> CreateTaskAsync(
        string statusText,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

Parameters

statusTextstringThe initial status text for the task.

cancellationTokenCancellationTokenoptionalThe cancellation token.

Returns

Task<IReportingTask>The created task.

CreateTaskAsync(MarkdownString, CancellationToken)abstractTask<IReportingTask>

Creates a new task within this step with Markdown-formatted status text.

public interface IReportingStep
{
    public abstract Task<IReportingTask> CreateTaskAsync(
        MarkdownString statusText,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

Parameters

statusTextMarkdownStringThe initial Markdown-formatted status text for the task.

cancellationTokenCancellationTokenoptionalThe cancellation token.

Returns

Task<IReportingTask>The created task.

Obsolete — Use Log(LogLevel, string) or Log(LogLevel, MarkdownString) instead.

Log(LogLevel, string, bool)abstract

Logs a message at the specified level within this step.

public interface IReportingStep
{
    public abstract void Log(
        LogLevel logLevel,
        string message,
        bool enableMarkdown)
    {
        // ...
    }
}

Parameters

logLevelLogLevelThe log level for the message.

messagestringThe message to log.

enableMarkdownboolWhether to enable Markdown formatting for the message.

Log(LogLevel, string)abstract

Logs a plain-text message at the specified level within this step.

public interface IReportingStep
{
    public abstract void Log(
        LogLevel logLevel,
        string message)
    {
        // ...
    }
}

Parameters

logLevelLogLevelThe log level for the message.

messagestringThe plain-text message to log.

Log(LogLevel, MarkdownString)abstract

Logs a Markdown-formatted message at the specified level within this step.

public interface IReportingStep
{
    public abstract void Log(
        LogLevel logLevel,
        MarkdownString message)
    {
        // ...
    }
}

Parameters

logLevelLogLevelThe log level for the message.

messageMarkdownStringThe Markdown-formatted message to log.