IPipelineActivityReporter Methods

CompletePublishAsync(PublishCompletionOptions?, CancellationToken) abstract Task

Signals that the entire publishing process has completed.

public interface IPipelineActivityReporter
{
    public abstract Task CompletePublishAsync(
        PublishCompletionOptions? options = null,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

Parameters

options PublishCompletionOptions? optional The options for completing the publishing process.

cancellationToken CancellationToken optional The cancellation token.

CompletePublishAsync(string?, CompletionState?, CancellationToken) abstract Task

Signals that the entire publishing process has completed.

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

Parameters

completionMessage string? optional The completion message of the publishing process.

completionState CompletionState? optional The completion state of the publishing process. When null, the state is automatically aggregated from all steps.

cancellationToken CancellationToken optional The cancellation token.

CreateStepAsync(string, CancellationToken) abstract Task<IReportingStep>

Creates a new publishing step with the specified title.

public interface IPipelineActivityReporter
{
    public abstract Task<IReportingStep> CreateStepAsync(
        string title,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

IPipelineActivityReporter.cs#L31

Parameters

title string The title of the publishing step.

cancellationToken CancellationToken optional The cancellation token.

Returns

Task<IReportingStep> The publishing step

CreateStepAsync(string, string?, int, CancellationToken) virtual Task<IReportingStep>

Creates a new publishing step with optional hierarchy metadata.

public interface IPipelineActivityReporter
{
    public virtual Task<IReportingStep> CreateStepAsync(
        string title,
        string? parentStepId,
        int hierarchyLevel,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

IPipelineActivityReporter.cs#L31

Parameters

title string The title of the publishing step.

parentStepId string? An optional identifier for the parent step.

hierarchyLevel int The hierarchy level for display.

cancellationToken CancellationToken optional The cancellation token.

Returns

Task<IReportingStep> The publishing step.