IReportingStep
Interface
interface IReportingStep { completeStep( completionText: string, completionState?: string, cancellationToken?: cancellationToken): void; completeStepMarkdown( markdownString: string, completionState?: string, cancellationToken?: cancellationToken): void; createMarkdownTask( markdownString: string, cancellationToken?: cancellationToken): IReportingTask; createTask( statusText: string, cancellationToken?: cancellationToken): IReportingTask; logStep( level: string, message: string): void; logStepMarkdown( level: string, markdownString: string): void;} 6 members
Methods
method
completeStep Completes the reporting step with plain-text completion text
completeStep( completionText: string, completionState?: string, cancellationToken?: cancellationToken): voidParameters
completionText string completionState string optional = completed cancellationToken cancellationToken optional method
completeStepMarkdown Completes the reporting step with Markdown-formatted completion text
completeStepMarkdown( markdownString: string, completionState?: string, cancellationToken?: cancellationToken): voidParameters
markdownString string completionState string optional = completed cancellationToken cancellationToken optional method
createMarkdownTask Creates a reporting task with Markdown-formatted status text
createMarkdownTask( markdownString: string, cancellationToken?: cancellationToken): IReportingTaskParameters
markdownString string cancellationToken cancellationToken optional Returns
IReportingTask method
createTask Creates a reporting task with plain-text status text
createTask( statusText: string, cancellationToken?: cancellationToken): IReportingTaskParameters
statusText string cancellationToken cancellationToken optional Returns
IReportingTask method
logStep Logs a plain-text message for the reporting step
logStep( level: string, message: string): voidParameters
level string message string method
logStepMarkdown Logs a Markdown-formatted message for the reporting step
logStepMarkdown( level: string, markdownString: string): voidParameters
level string markdownString string