API Reference
Class
AuditDeliverySummaryWriter
Writes delivery summary documents to disk.
Inheritance
- Object
- AuditDeliverySummaryWriter
Methods
public static async Task<String> WriteHtmlAsync(String path, AuditDeliverySummaryDocument document, CancellationToken ct = null) #Returns:
Task<String>Writes a delivery summary as a standalone HTML document.
Parameters
- path System.String
- Output file path.
- document TestimoX.AuditWorkspaces.AuditDeliverySummaryDocument
- Summary document.
- ct System.Threading.CancellationToken = null
- Cancellation token.
Returns
The written file path.
public static async Task<String> WriteJsonAsync(String path, AuditDeliverySummaryDocument document, CancellationToken ct = null) #Returns:
Task<String>Writes a delivery summary as indented JSON.
Parameters
- path System.String
- Output file path.
- document TestimoX.AuditWorkspaces.AuditDeliverySummaryDocument
- Summary document.
- ct System.Threading.CancellationToken = null
- Cancellation token.
Returns
The written file path.
public static async Task<String> WriteMarkdownAsync(String path, AuditDeliverySummaryDocument document, CancellationToken ct = null) #Returns:
Task<String>Writes a delivery summary as markdown.
Parameters
- path System.String
- Output file path.
- document TestimoX.AuditWorkspaces.AuditDeliverySummaryDocument
- Summary document.
- ct System.Threading.CancellationToken = null
- Cancellation token.
Returns
The written file path.
public static async Task<String> WriteWordAsync(String path, AuditDeliverySummaryDocument document, CancellationToken ct = null) #Returns:
Task<String>Writes a delivery summary as a Word document for consultant and client review.
Parameters
- path System.String
- Output file path.
- document TestimoX.AuditWorkspaces.AuditDeliverySummaryDocument
- Summary document.
- ct System.Threading.CancellationToken = null
- Cancellation token.
Returns
The written file path.