Interface IReporter

Namespace

CSF.Screenplay.Reporting

Assembly

CSF.Screenplay.Abstractions.dll

Defines a reporter that subscribes to and processes events from a Screenplay event notifier.

public interface IReporter : IDisposable

Inherited Members

IDisposable.Dispose()

Remarks

Implementations of this interface are responsible for accumulating information about the Screenplay as events are received, and generating reports based on that information.

Methods

SubscribeTo(IHasPerformanceEvents)

Subscribes to the events emitted by the specified Screenplay event notifier.

void SubscribeTo(IHasPerformanceEvents events)

Parameters

events IHasPerformanceEvents

A Screenplay event notifier

Remarks

As events are received, this reporter instance may accumulate information about the Screnplay that it is to report upon.

UnsubscribeFrom(IHasPerformanceEvents)

Unsubscribes from the specified Screenplay event notifier.

void UnsubscribeFrom(IHasPerformanceEvents events)

Parameters

events IHasPerformanceEvents

A Screenplay event notifier

Remarks

Use this method only after the event notifier has emitted the ScreenplayEnded event. If this reporter unsubscribes from Screenplay events before the Screenplay has ended then the results are undefined. This could lead to a corrupt report file.