Skip to content

Commit 6a94297

Browse files
craigfowlerGithub Actions Workflow (bot)
authored andcommitted
Publish updated documentation website
1 parent 80b193f commit 6a94297

13 files changed

Lines changed: 946 additions & 66 deletions

docs/api/CSF.Screenplay.ScreenplayOptions.html

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ <h2 class="section" id="properties">Properties
168168

169169
<h3 id="CSF_Screenplay_ScreenplayOptions_OnBeginScreenplayActions" data-uid="CSF.Screenplay.ScreenplayOptions.OnBeginScreenplayActions">
170170
OnBeginScreenplayActions
171-
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay/ScreenplayOptions.cs/#L131"><i class="bi bi-code-slash"></i></a>
171+
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay/ScreenplayOptions.cs/#L137"><i class="bi bi-code-slash"></i></a>
172172
</h3>
173173

174174
<div class="markdown level1 summary"><p>Gets an ordered collection of actions which should be executed when the <a class="xref" href="CSF.Screenplay.Screenplay.html">Screenplay</a> begins, before the first
@@ -214,7 +214,7 @@ <h4 class="section" id="CSF_Screenplay_ScreenplayOptions_OnBeginScreenplayAction
214214

215215
<h3 id="CSF_Screenplay_ScreenplayOptions_OnEndScreenplayActions" data-uid="CSF.Screenplay.ScreenplayOptions.OnEndScreenplayActions">
216216
OnEndScreenplayActions
217-
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay/ScreenplayOptions.cs/#L160"><i class="bi bi-code-slash"></i></a>
217+
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay/ScreenplayOptions.cs/#L166"><i class="bi bi-code-slash"></i></a>
218218
</h3>
219219

220220
<div class="markdown level1 summary"><p>Gets an ordered collection of actions which should be executed when the <a class="xref" href="CSF.Screenplay.Screenplay.html">Screenplay</a> finished, after the last
@@ -259,20 +259,20 @@ <h4 class="section" id="CSF_Screenplay_ScreenplayOptions_OnEndScreenplayActions_
259259

260260

261261

262-
<a id="CSF_Screenplay_ScreenplayOptions_PerformanceEventsConfig_" data-uid="CSF.Screenplay.ScreenplayOptions.PerformanceEventsConfig*"></a>
262+
<a id="CSF_Screenplay_ScreenplayOptions_PerformanceEventHandlers_" data-uid="CSF.Screenplay.ScreenplayOptions.PerformanceEventHandlers*"></a>
263263

264-
<h3 id="CSF_Screenplay_ScreenplayOptions_PerformanceEventsConfig" data-uid="CSF.Screenplay.ScreenplayOptions.PerformanceEventsConfig">
265-
PerformanceEventsConfig
266-
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay/ScreenplayOptions.cs/#L112"><i class="bi bi-code-slash"></i></a>
264+
<h3 id="CSF_Screenplay_ScreenplayOptions_PerformanceEventHandlers" data-uid="CSF.Screenplay.ScreenplayOptions.PerformanceEventHandlers">
265+
PerformanceEventHandlers
266+
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay/ScreenplayOptions.cs/#L118"><i class="bi bi-code-slash"></i></a>
267267
</h3>
268268

269-
<div class="markdown level1 summary"><p>An optional callback/action which exposes the various <a class="xref" href="CSF.Screenplay.Performances.IHasPerformanceEvents.html">IHasPerformanceEvents</a> which may be subscribed-to in order to be notified
269+
<div class="markdown level1 summary"><p>A collection of optional callbacks/actions which expose the various <a class="xref" href="CSF.Screenplay.Performances.IHasPerformanceEvents.html">IHasPerformanceEvents</a> which may be subscribed-to in order to be notified
270270
of the progress of a screenplay.</p>
271271
</div>
272272
<div class="markdown level1 conceptual"></div>
273273

274274
<div class="codewrapper">
275-
<pre><code class="lang-csharp hljs">public Action&lt;IHasPerformanceEvents&gt; PerformanceEventsConfig { get; set; }</code></pre>
275+
<pre><code class="lang-csharp hljs">public List&lt;Action&lt;IHasPerformanceEvents, IServiceProvider&gt;&gt; PerformanceEventHandlers { get; }</code></pre>
276276
</div>
277277

278278

@@ -281,23 +281,29 @@ <h3 id="CSF_Screenplay_ScreenplayOptions_PerformanceEventsConfig" data-uid="CSF.
281281

282282
<h4 class="section">Property Value</h4>
283283
<dl class="parameters">
284-
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-1">Action</a>&lt;<a class="xref" href="CSF.Screenplay.Performances.IHasPerformanceEvents.html">IHasPerformanceEvents</a>&gt;</dt>
284+
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-2">Action</a>&lt;<a class="xref" href="CSF.Screenplay.Performances.IHasPerformanceEvents.html">IHasPerformanceEvents</a>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iserviceprovider">IServiceProvider</a>&gt;&gt;</dt>
285285
<dd></dd>
286286
</dl>
287287

288288

289289

290290

291-
<h4 class="section" id="CSF_Screenplay_ScreenplayOptions_PerformanceEventsConfig_remarks">Remarks</h4>
291+
<h4 class="section" id="CSF_Screenplay_ScreenplayOptions_PerformanceEventHandlers_remarks">Remarks</h4>
292292
<div class="markdown level1 remarks"><p>
293293
The implementation of <a class="xref" href="CSF.Screenplay.Performances.IHasPerformanceEvents.html">IHasPerformanceEvents</a> is an event publisher which emits notifications when key evens occur during the lifetime
294294
of a <a class="xref" href="CSF.Screenplay.Screenplay.html">Screenplay</a> and its performances: <a class="xref" href="CSF.Screenplay.IPerformance.html">IPerformance</a>.
295295
If you wish, you may subscribe to these events from your own logic in order to develop new functionality or extend Screenplay.
296296
</p>
297297
<p>
298-
There is no need to add an explicit subscription to any events for the reporting infrastructure.
299-
Screenplay will automatically subscribe to this object from the reporting mechanism, unless the value of <a class="xref" href="CSF.Screenplay.ScreenplayOptions.html#CSF_Screenplay_ScreenplayOptions_ReportPath">ReportPath</a> means that
300-
reporting is disabled.
298+
There is no need to use this mechanism in order to use the Screenplay Reporting infrastructure.
299+
Built-in logic will automatically subscribe to the event published from the reporting infrastructure.
300+
Note that if <a class="xref" href="CSF.Screenplay.ScreenplayOptions.html#CSF_Screenplay_ScreenplayOptions_ReportPath">ReportPath</a> is a null or whitepsace-only string, the reporting infrastructure will be disabled.
301+
</p>
302+
<p>
303+
This collection of configuration callbacks may be used to subscribe to the event publisher from custom Screenplay extensions, in order
304+
be notified at particular points in the Screenplay's lifecycle.
305+
Each extension should add a single item to this list of callbacks. In this manner, multiple extensions may coexist without worrying about
306+
overwriting one another's event subscriptions.
301307
</p>
302308
</div>
303309

@@ -401,7 +407,7 @@ <h4 class="section" id="CSF_Screenplay_ScreenplayOptions_ValueFormatters_remarks
401407
</p>
402408
<p>
403409
Make use of <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.icollection-1.add">Add(T)</a> to add new formatters to the end of this collection.
404-
It comes pre-loaded with three generalised formatters by default, in the following order.
410+
It comes pre-loaded with some general-use formatters by default, in the following order.
405411
</p>
406412
<ol><li><a class="xref" href="CSF.Screenplay.Reporting.ToStringFormatter.html">ToStringFormatter</a> - a default/fallback implementation which may format any value at all</li><li><a class="xref" href="CSF.Screenplay.Reporting.HumanizerFormatter.html">HumanizerFormatter</a> - a formatter for dates, times &amp; time spans which uses the Humanizer library</li><li><a class="xref" href="CSF.Screenplay.Reporting.NameFormatter.html">NameFormatter</a> - which formats values that implement <a class="xref" href="CSF.Screenplay.IHasName.html">IHasName</a> by emitting their name</li><li><a class="xref" href="CSF.Screenplay.Reporting.FormattableFormatter.html">FormattableFormatter</a> - which formats values that implement <a class="xref" href="CSF.Screenplay.Reporting.IFormattableValue.html">IFormattableValue</a></li></ol>
407413
<p>

0 commit comments

Comments
 (0)