Class ScreenplayReport

Namespace

CSF.Screenplay.ReportModel

Assembly

CSF.Screenplay.dll

Represents a complete Screenplay report.

public class ScreenplayReport

Inheritance

object

ScreenplayReport

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

This type is not used in the writing of Screenplay reports; the JsonScreenplayReporter writes the report by streaming it to a file as it is generated. This type is used only for the deserialization of a report file.

Properties

Metadata

Gets or sets the metadata for the report.

public ReportMetadata Metadata { get; set; }

Property Value

ReportMetadata

Performances

Gets or sets the performances which are included within the report.

public ICollection<PerformanceReport> Performances { get; set; }

Property Value

ICollection<PerformanceReport>

Remarks

There is no defined order to the performances within the report. The order in which they appear in this collection will correspond to the order in which they were serialized to the report file. However, because performances may occur in parallel, there is no guarantee that the order will be stable between different reports, even if the Screenplay and IPerformance instances contained are the same, with the same logic.