Class PerformanceFinishedEventArgs

Namespace

CSF.Screenplay.Performances

Assembly

CSF.Screenplay.Abstractions.dll

A model for event arguments which relate to a finishing of a IPerformance.

public class PerformanceFinishedEventArgs : PerformanceEventArgs, IHasPerformanceIdentity

Inheritance

object

EventArgs

PerformanceScopeEventArgs

PerformanceEventArgs

PerformanceFinishedEventArgs

Implements

IHasPerformanceIdentity

Inherited Members

PerformanceEventArgs.NamingHierarchy

PerformanceScopeEventArgs.PerformanceIdentity

EventArgs.Empty

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

PerformanceFinishedEventArgs(Guid, IReadOnlyList<IdentifierAndName>, bool?)

Initialises a new instance of PerformanceEventArgs

public PerformanceFinishedEventArgs(Guid performanceIdentity, IReadOnlyList<IdentifierAndName> namingHierarchy, bool? success)

Parameters

performanceIdentity Guid

The performance identity

namingHierarchy IReadOnlyList<IdentifierAndName>

The scenario hierarchy

success bool?

A value indicating whether or not the scenario completed with a succeess result

Exceptions

ArgumentNullException

If the scenario hierarchy is null

Properties

Success

Gets a value indicating whether the finished IPerformance was a success or not

public bool? Success { get; }

Property Value

bool?

Remarks

The three possible values for this property correspond to three possible values of PerformanceState which represent a performance that has finished.

Value	Corresponding state
true	Success
false	Failed
null	Completed

When using Screenplay with Integration, these three performance states may go on to correspond to a test pass, failure or skipped/ignored test, respectively.

See Also

IPerformance

PerformanceScopeEventArgs

PerformanceEventArgs