IReportingStep Methods
Interface Methods 3 members
Represents a publishing step, which can contain multiple tasks.
CompleteAsync(string, CompletionState, CancellationToken) Section titled CompleteAsync(string, CompletionState, CancellationToken) abstract Task 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
completionText string The completion text for the step. completionState CompletionState optional The completion state for the step. cancellationToken CancellationToken optional The cancellation token. CreateTaskAsync(string, CancellationToken) Section titled CreateTaskAsync(string, CancellationToken) abstract Task<IReportingTask> Creates a new task within this step.
public interface IReportingStep{ public abstract Task<IReportingTask> CreateTaskAsync( string statusText, CancellationToken cancellationToken = default(CancellationToken)) { // ... }}Parameters
statusText string The initial status text for the task. cancellationToken CancellationToken optional The cancellation token. Returns
Task<IReportingTask> The created task. Logs a message at the specified level within this step.
public interface IReportingStep{ public abstract void Log( LogLevel logLevel, string message, bool enableMarkdown) { // ... }}Parameters
logLevel LogLevel The log level for the message. message string The message to log. enableMarkdown bool Whether to enable Markdown formatting for the message.