Skip to content

Assertions: Reporting and artifacts

TL;DR — This page mirrors the Reporting and artifacts section from Assertions as a focused reference.

When to use

Use this page when you need the focused member list, signatures, and source notes for this section without scanning the full parent reference.

C# (CAC) usage

ReportOnlyStatuses

Source file, signature, and docstring

Member AssertionBuilder.ReportOnlyStatuses(IList<AssertionStatus> statusesToReport)

Kind function

Declaring Type AssertionBuilder

Source File QaaS.Runner.Assertions/ConfigurationObjects/AssertionBuilder.cs

Signature 

public AssertionBuilder ReportOnlyStatuses(IList<AssertionStatus> statusesToReport)

Docstring

Sets which assertion statuses should be included in reports.

ShouldSaveSessionData

Source file, signature, and docstring

Member AssertionBuilder.ShouldSaveSessionData(bool shouldSaveSessionData)

Kind function

Declaring Type AssertionBuilder

Source File QaaS.Runner.Assertions/ConfigurationObjects/AssertionBuilder.cs

Signature 

public AssertionBuilder ShouldSaveSessionData(bool shouldSaveSessionData)

Docstring

Configures whether session data is saved with the assertion result.

ShouldSaveLogs

Source file, signature, and docstring

Member AssertionBuilder.ShouldSaveLogs(bool shouldSaveLogs)

Kind function

Declaring Type AssertionBuilder

Source File QaaS.Runner.Assertions/ConfigurationObjects/AssertionBuilder.cs

Signature 

public AssertionBuilder ShouldSaveLogs(bool shouldSaveLogs)

Docstring

Configures whether logs are saved with the assertion result.

ShouldSaveConfigurationTemplate

Source file, signature, and docstring

Member AssertionBuilder.ShouldSaveConfigurationTemplate(bool shouldSaveConfigurationTemplate)

Kind function

Declaring Type AssertionBuilder

Source File QaaS.Runner.Assertions/ConfigurationObjects/AssertionBuilder.cs

Signature 

public AssertionBuilder ShouldSaveConfigurationTemplate(bool shouldSaveConfigurationTemplate)

Docstring

Configures whether the rendered configuration template is saved with the assertion result.

ShouldSaveAttachments

Source file, signature, and docstring

Member AssertionBuilder.ShouldSaveAttachments(bool shouldSaveAttachments)

Kind function

Declaring Type AssertionBuilder

Source File QaaS.Runner.Assertions/ConfigurationObjects/AssertionBuilder.cs

Signature 

public AssertionBuilder ShouldSaveAttachments(bool shouldSaveAttachments)

Docstring

Configures whether attachments are saved with the assertion result.

ShouldDisplayTrace

Source file, signature, and docstring

Member AssertionBuilder.ShouldDisplayTrace(bool shouldDisplayTrace)

Kind function

Declaring Type AssertionBuilder

Source File QaaS.Runner.Assertions/ConfigurationObjects/AssertionBuilder.cs

Signature 

public AssertionBuilder ShouldDisplayTrace(bool shouldDisplayTrace)

Docstring

Configures whether the assertion trace is displayed with the result.

Edge cases

  • This page is generated from the parent reference section; edit the source XML docs or generator when content needs to change.
  • If a linked source member is renamed, regenerate the reference docs before changing prose by hand.

See also