NullPublishingActivityReporter Methods

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

ClassMethods3 members

A no-op implementation of IPipelineActivityReporter for testing purposes.

CompletePublishAsync(PublishCompletionOptions?, CancellationToken)Task

Signals that the entire publishing process has completed.

public sealed class NullPublishingActivityReporter
{
    public Task CompletePublishAsync(
        PublishCompletionOptions? options = null,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

NullPipelineActivityReporter.cs#L26

Parameters

optionsPublishCompletionOptions?optionalThe options for completing the publishing process.

cancellationTokenCancellationTokenoptionalThe cancellation token.

Obsolete — Use CompletePublishAsync(PublishCompletionOptions?, CancellationToken) instead.

CompletePublishAsync(string?, CompletionState?, CancellationToken)Task

Signals that the entire publishing process has completed.

public sealed class NullPublishingActivityReporter
{
    public Task CompletePublishAsync(
        string? completionMessage = null,
        CompletionState? completionState = null,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

NullPipelineActivityReporter.cs#L33

Parameters

completionMessagestring?optionalThe completion message of the publishing process.

completionStateCompletionState?optionalThe completion state of the publishing process. When null, the state is automatically aggregated from all steps.

cancellationTokenCancellationTokenoptionalThe cancellation token.

CreateStepAsync(string, CancellationToken)Task<IReportingStep>

Creates a new publishing step with the specified title.

public sealed class NullPublishingActivityReporter
{
    public Task<IReportingStep> CreateStepAsync(
        string title,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

NullPipelineActivityReporter.cs#L20

Parameters

titlestringThe title of the publishing step.

cancellationTokenCancellationTokenoptionalThe cancellation token.

Returns

Task<IReportingStep>The publishing step