TestimoX

API Reference

Class

AuditDeliveryBundleWriter

Edit on GitHub
Namespace TestimoX.AuditWorkspaces.Serialization
Assembly TestimoX
Source TestimoX/AuditWorkspaces/Serialization/AuditDeliveryBundleWriter.cs:285
Modifiers static

Writes convenience assets for an offline audit delivery bundle.

Inheritance

  • Object
  • AuditDeliveryBundleWriter

Methods

public static String CreateZip(String sourceDirectory, String zipPath) #
TestimoX/AuditWorkspaces/Serialization/AuditDeliveryBundleWriter.cs:285
Returns: String

Creates a zip archive from an existing delivery bundle directory.

Parameters

sourceDirectory System.String requiredposition: 0
Bundle root directory.
zipPath System.String requiredposition: 1
Target zip path.

Returns

The written zip file path.

public static async Task<String> WriteIndexHtmlAsync(String path, AuditDeliveryBundleManifest manifest, AuditDeliverySummaryDocument summary, CancellationToken ct = null) #
Returns: Task<String>

Writes an index page that links bundle artifacts for browser-based review.

Parameters

path System.String requiredposition: 0
Output file path.
manifest TestimoX.AuditWorkspaces.AuditDeliveryBundleManifest requiredposition: 1
Bundle manifest.
summary TestimoX.AuditWorkspaces.AuditDeliverySummaryDocument requiredposition: 2
Delivery summary included in the bundle.
ct System.Threading.CancellationToken = null optionalposition: 3
Cancellation token.

Returns

The written file path.

public static async Task<String> WriteReadmeMarkdownAsync(String path, AuditDeliveryBundleManifest manifest, AuditDeliverySummaryDocument summary, CancellationToken ct = null) #
Returns: Task<String>

Writes a markdown guide that explains the generated delivery bundle contents.

Parameters

path System.String requiredposition: 0
Output file path.
manifest TestimoX.AuditWorkspaces.AuditDeliveryBundleManifest requiredposition: 1
Bundle manifest.
summary TestimoX.AuditWorkspaces.AuditDeliverySummaryDocument requiredposition: 2
Delivery summary included in the bundle.
ct System.Threading.CancellationToken = null optionalposition: 3
Cancellation token.

Returns

The written file path.