TestimoX

API Reference

Class

TestimoXDocumentation

Edit on GitHub
Namespace TestimoX.Documentation
Assembly TestimoX
Source TestimoX/Documentation/TestimoXDocumentation.cs:14
Modifiers static

Provides compact C# entry points for general TestimoX documentation authoring and saving.

Inheritance

  • Object
  • TestimoXDocumentation

Methods

Create 2 overloads
public static DocumentationReport Create(Action<DocumentationAuthoringSession> configure) #
TestimoX/Documentation/TestimoXDocumentation.cs:14
Returns: DocumentationReport

Creates a renderer-neutral documentation report from an authoring callback.

Parameters

configure System.Action{TestimoX.Documentation.DocumentationAuthoringSession} requiredposition: 0
Authoring callback.

Returns

A documentation report.

public static DocumentationReport Create(String title, Action<DocumentationAuthoringSession> configure) #
TestimoX/Documentation/TestimoXDocumentation.cs:23
Returns: DocumentationReport

Creates a renderer-neutral documentation report with a title from an authoring callback.

Parameters

title System.String requiredposition: 0
Report title.
configure System.Action{TestimoX.Documentation.DocumentationAuthoringSession} requiredposition: 1
Authoring callback.

Returns

A documentation report.

public static TestimoXDocumentationSaveRequest CreateSaveRequest(DocumentationReport report, String snapshotId = null, String snapshotName = null) #
TestimoX/Documentation/TestimoXDocumentation.cs:37
Returns: TestimoXDocumentationSaveRequest

Creates a reusable save request from a report and the output/storage intents carried by that report.

Parameters

report TestimoX.Documentation.DocumentationReport requiredposition: 0
Report to save.
snapshotId System.String = null optionalposition: 1
Optional replay snapshot identifier.
snapshotName System.String = null optionalposition: 2
Optional replay snapshot display name.

Returns

A save request ready for TestimoXDocumentationSavePipeline.

SaveAsync 4 overloads
public static Task<TestimoXDocumentationSaveResult> SaveAsync(Action<DocumentationAuthoringSession> configure, String snapshotId = null, String snapshotName = null, CancellationToken cancellationToken = null) #
TestimoX/Documentation/TestimoXDocumentation.cs:104
Returns: Task<TestimoXDocumentationSaveResult>

Saves a documentation report through the shared TestimoX documentation save pipeline.

Parameters

report TestimoX.Documentation.DocumentationReport requiredposition: 0
Report to save.
snapshotId System.String = null optionalposition: 1
Optional replay snapshot identifier.
snapshotName System.String = null optionalposition: 2
Optional replay snapshot display name.
cancellationToken System.Threading.CancellationToken = null optionalposition: 3
Cancellation token.

Returns

Save result with artifact, storage, and localization evidence.

public static Task<TestimoXDocumentationSaveResult> SaveAsync(String title, Action<DocumentationAuthoringSession> configure, String snapshotId = null, String snapshotName = null, CancellationToken cancellationToken = null) #
TestimoX/Documentation/TestimoXDocumentation.cs:121
Returns: Task<TestimoXDocumentationSaveResult>

Saves a documentation report through a supplied save pipeline.

Parameters

report TestimoX.Documentation.DocumentationReport requiredposition: 0
Report to save.
pipeline TestimoX.Documentation.TestimoXDocumentationSavePipeline requiredposition: 1
Save pipeline.
snapshotId System.String = null optionalposition: 2
Optional replay snapshot identifier.
snapshotName System.String = null optionalposition: 3
Optional replay snapshot display name.
cancellationToken System.Threading.CancellationToken = null optionalposition: 4
Cancellation token.

Returns

Save result with artifact, storage, and localization evidence.

SaveAsync(System.Action{TestimoX.Documentation.DocumentationAuthoringSession} configure, System.String snapshotId, System.String snapshotName, System.Threading.CancellationToken cancellationToken) #

Creates and saves a documentation report from an authoring callback.

Parameters

configure System.Action{TestimoX.Documentation.DocumentationAuthoringSession} required
Authoring callback.
snapshotId System.String required
Optional replay snapshot identifier.
snapshotName System.String required
Optional replay snapshot display name.
cancellationToken System.Threading.CancellationToken required
Cancellation token.

Returns

Save result with artifact, storage, and localization evidence.

SaveAsync(System.String title, System.Action{TestimoX.Documentation.DocumentationAuthoringSession} configure, System.String snapshotId, System.String snapshotName, System.Threading.CancellationToken cancellationToken) #

Creates and saves a titled documentation report from an authoring callback.

Parameters

title System.String required
Report title.
configure System.Action{TestimoX.Documentation.DocumentationAuthoringSession} required
Authoring callback.
snapshotId System.String required
Optional replay snapshot identifier.
snapshotName System.String required
Optional replay snapshot display name.
cancellationToken System.Threading.CancellationToken required
Cancellation token.

Returns

Save result with artifact, storage, and localization evidence.