IReportingTask

Interface

📦 Aspire.Hosting v13.4.0

interface IReportingTask {
  completeTask(
      completionMessage?: string,
      completionState?: string,
      cancellationToken?: cancellationToken): void;
  completeTaskMarkdown(
      markdownString: string,
      completionState?: string,
      cancellationToken?: cancellationToken): void;
  updateTask(
      statusText: string,
      cancellationToken?: cancellationToken): void;
  updateTaskMarkdown(
      markdownString: string,
      cancellationToken?: cancellationToken): void;
}

Methods

methodcompleteTask

Completes the reporting task with plain-text completion text.

completeTask(
    completionMessage?: string,
    completionState?: string,
    cancellationToken?: cancellationToken): void

Parameters

completionMessagestringoptional

completionStatestringoptional= completed

cancellationTokencancellationTokenoptional

methodcompleteTaskMarkdown

Completes the reporting task with Markdown-formatted completion text.

completeTaskMarkdown(
    markdownString: string,
    completionState?: string,
    cancellationToken?: cancellationToken): void

Parameters

markdownStringstring

completionStatestringoptional= completed

cancellationTokencancellationTokenoptional

methodupdateTask

Updates the reporting task with plain-text status text.

updateTask(
    statusText: string,
    cancellationToken?: cancellationToken): void

Parameters

statusTextstring

cancellationTokencancellationTokenoptional

methodupdateTaskMarkdown

Updates the reporting task with Markdown-formatted status text.

updateTaskMarkdown(
    markdownString: string,
    cancellationToken?: cancellationToken): void

Parameters

markdownStringstring

cancellationTokencancellationTokenoptional