Skip to content

Commit fc1e0e8

Browse files
author
Appveyor (on behalf of Craig Fowler)
committed
Auto: Merge docs website via CI [skip ci]
2 parents 426d2ec + 622772e commit fc1e0e8

491 files changed

Lines changed: 49299 additions & 4252 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/api/CSF.Screenplay.Abilities.GetAssetFilePaths.html‎

Lines changed: 273 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,273 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta charset="utf-8">
5+
<title>Class GetAssetFilePaths | Screenplay docs </title>
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
7+
<meta name="title" content="Class GetAssetFilePaths | Screenplay docs ">
8+
9+
<meta name="description" content="Screenplay ability which gets the file system path for asset files generated by actors participating in the current performance.">
10+
<link rel="icon" href="../favicon.ico">
11+
<link rel="stylesheet" href="../public/docfx.min.css">
12+
<link rel="stylesheet" href="../public/main.css">
13+
<meta name="docfx:navrel" content="../toc.html">
14+
<meta name="docfx:tocrel" content="toc.html">
15+
16+
<meta name="docfx:rel" content="../">
17+
18+
19+
<meta name="docfx:docurl" content="https://github.com/csf-dev/CSF.Screenplay/new/master/apiSpec/new?filename=CSF_Screenplay_Abilities_GetAssetFilePaths.md&amp;value=---%0Auid%3A%20CSF.Screenplay.Abilities.GetAssetFilePaths%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">
20+
<meta name="loc:inThisArticle" content="In this article">
21+
<meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
22+
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
23+
<meta name="loc:tocFilter" content="Filter by title">
24+
<meta name="loc:nextArticle" content="Next">
25+
<meta name="loc:prevArticle" content="Previous">
26+
<meta name="loc:themeLight" content="Light">
27+
<meta name="loc:themeDark" content="Dark">
28+
<meta name="loc:themeAuto" content="Auto">
29+
<meta name="loc:changeTheme" content="Change theme">
30+
<meta name="loc:copy" content="Copy">
31+
<meta name="loc:downloadPdf" content="Download PDF">
32+
33+
<script type="module" src="./../public/docfx.min.js"></script>
34+
35+
<script>
36+
const theme = localStorage.getItem('theme') || 'auto'
37+
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
38+
</script>
39+
40+
</head>
41+
42+
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
43+
<header class="bg-body border-bottom">
44+
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
45+
<div class="container-xxl flex-nowrap">
46+
<a class="navbar-brand" href="../index.html">
47+
<img id="logo" class="svg" src="../logo.svg" alt="CSF.Screenplay">
48+
CSF.Screenplay
49+
</a>
50+
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
51+
<i class="bi bi-three-dots"></i>
52+
</button>
53+
<div class="collapse navbar-collapse" id="navpanel">
54+
<div id="navbar">
55+
<form class="search" role="search" id="search">
56+
<i class="bi bi-search"></i>
57+
<input class="form-control" id="search-query" type="search" disabled placeholder="Search" autocomplete="off" aria-label="Search">
58+
</form>
59+
</div>
60+
</div>
61+
</div>
62+
</nav>
63+
</header>
64+
65+
<main class="container-xxl">
66+
<div class="toc-offcanvas">
67+
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
68+
<div class="offcanvas-header">
69+
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
70+
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
71+
</div>
72+
<div class="offcanvas-body">
73+
<nav class="toc" id="toc"></nav>
74+
</div>
75+
</div>
76+
</div>
77+
78+
<div class="content">
79+
<div class="actionbar">
80+
<button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
81+
<i class="bi bi-list"></i>
82+
</button>
83+
84+
<nav id="breadcrumb"></nav>
85+
</div>
86+
87+
<article data-uid="CSF.Screenplay.Abilities.GetAssetFilePaths">
88+
89+
90+
91+
<h1 id="CSF_Screenplay_Abilities_GetAssetFilePaths" data-uid="CSF.Screenplay.Abilities.GetAssetFilePaths" class="text-break">
92+
Class GetAssetFilePaths <a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay.Abstractions/Abilities/GetAssetFilePaths.cs/#L8"><i class="bi bi-code-slash"></i></a>
93+
</h1>
94+
95+
<div class="facts text-secondary">
96+
<dl><dt>Namespace</dt><dd><a class="xref" href="CSF.html">CSF</a>.<a class="xref" href="CSF.Screenplay.html">Screenplay</a>.<a class="xref" href="CSF.Screenplay.Abilities.html">Abilities</a></dd></dl>
97+
<dl><dt>Assembly</dt><dd>CSF.Screenplay.Abstractions.dll</dd></dl>
98+
</div>
99+
100+
<div class="markdown summary"><p>Screenplay ability which gets the file system path for asset files generated by actors participating in the current performance.</p>
101+
</div>
102+
<div class="markdown conceptual"></div>
103+
104+
<div class="codewrapper">
105+
<pre><code class="lang-csharp hljs">public class GetAssetFilePaths</code></pre>
106+
</div>
107+
108+
109+
110+
111+
<dl class="typelist inheritance">
112+
<dt>Inheritance</dt>
113+
<dd>
114+
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
115+
<div><span class="xref">GetAssetFilePaths</span></div>
116+
</dd>
117+
</dl>
118+
119+
120+
121+
<dl class="typelist inheritedMembers">
122+
<dt>Inherited Members</dt>
123+
<dd>
124+
<div>
125+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
126+
</div>
127+
<div>
128+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
129+
</div>
130+
<div>
131+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
132+
</div>
133+
<div>
134+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
135+
</div>
136+
<div>
137+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
138+
</div>
139+
<div>
140+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
141+
</div>
142+
<div>
143+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
144+
</div>
145+
</dd></dl>
146+
147+
148+
149+
150+
151+
152+
<h2 class="section" id="constructors">Constructors
153+
</h2>
154+
155+
156+
<a id="CSF_Screenplay_Abilities_GetAssetFilePaths__ctor_" data-uid="CSF.Screenplay.Abilities.GetAssetFilePaths.#ctor*"></a>
157+
158+
<h3 id="CSF_Screenplay_Abilities_GetAssetFilePaths__ctor_CSF_Screenplay_Reporting_IGetsAssetFilePath_" data-uid="CSF.Screenplay.Abilities.GetAssetFilePaths.#ctor(CSF.Screenplay.Reporting.IGetsAssetFilePath)">
159+
GetAssetFilePaths(IGetsAssetFilePath)
160+
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay.Abstractions/Abilities/GetAssetFilePaths.cs/#L34"><i class="bi bi-code-slash"></i></a>
161+
</h3>
162+
163+
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="CSF.Screenplay.Abilities.GetAssetFilePaths.html">GetAssetFilePaths</a> class.</p>
164+
</div>
165+
<div class="markdown level1 conceptual"></div>
166+
167+
<div class="codewrapper">
168+
<pre><code class="lang-csharp hljs">public GetAssetFilePaths(IGetsAssetFilePath pathProvider)</code></pre>
169+
</div>
170+
171+
<h4 class="section">Parameters</h4>
172+
<dl class="parameters">
173+
<dt><code>pathProvider</code> <a class="xref" href="CSF.Screenplay.Reporting.IGetsAssetFilePath.html">IGetsAssetFilePath</a></dt>
174+
<dd><p>The path provider used to get asset file paths.</p>
175+
</dd>
176+
</dl>
177+
178+
179+
180+
181+
182+
183+
184+
185+
186+
187+
188+
189+
<h2 class="section" id="methods">Methods
190+
</h2>
191+
192+
193+
<a id="CSF_Screenplay_Abilities_GetAssetFilePaths_GetAssetFilePath_" data-uid="CSF.Screenplay.Abilities.GetAssetFilePaths.GetAssetFilePath*"></a>
194+
195+
<h3 id="CSF_Screenplay_Abilities_GetAssetFilePaths_GetAssetFilePath_System_String_" data-uid="CSF.Screenplay.Abilities.GetAssetFilePaths.GetAssetFilePath(System.String)">
196+
GetAssetFilePath(string)
197+
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay.Abstractions/Abilities/GetAssetFilePaths.cs/#L28"><i class="bi bi-code-slash"></i></a>
198+
</h3>
199+
200+
<div class="markdown level1 summary"><p>Gets the file system path for the specified asset file.</p>
201+
</div>
202+
<div class="markdown level1 conceptual"></div>
203+
204+
<div class="codewrapper">
205+
<pre><code class="lang-csharp hljs">public string GetAssetFilePath(string baseName)</code></pre>
206+
</div>
207+
208+
<h4 class="section">Parameters</h4>
209+
<dl class="parameters">
210+
<dt><code>baseName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
211+
<dd><p>A short descriptive file name fragment for the asset file, including the file extension.</p>
212+
</dd>
213+
</dl>
214+
215+
<h4 class="section">Returns</h4>
216+
<dl class="parameters">
217+
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
218+
<dd><p>The asset file path.</p>
219+
</dd>
220+
</dl>
221+
222+
223+
224+
225+
226+
227+
228+
<h4 class="section" id="CSF_Screenplay_Abilities_GetAssetFilePaths_GetAssetFilePath_System_String__remarks">Remarks</h4>
229+
<div class="markdown level1 remarks"><p>
230+
The returned file system path is an absolute path to which the asset file should be written. The path is determined by the
231+
logic of the service <a class="xref" href="CSF.Screenplay.Reporting.IGetsAssetFilePath.html">IGetsAssetFilePath</a>. This means that the final filename will not be identical to the
232+
<code class="paramref">baseName</code> but will include that base name within it.
233+
</p>
234+
<p>
235+
If this method returns <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null">null</a> then the asset file should not be written to the file system.
236+
</p>
237+
</div>
238+
239+
240+
<dl class="typelist seealso">
241+
<dt>See Also</dt>
242+
<dd>
243+
<div><a class="xref" href="CSF.Screenplay.Reporting.IGetsAssetFilePath.html#CSF_Screenplay_Reporting_IGetsAssetFilePath_GetAssetFilePath_System_String_">GetAssetFilePath</a>(<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>)</div>
244+
</dd>
245+
</dl>
246+
247+
248+
249+
</article>
250+
251+
<div class="contribution d-print-none">
252+
<a href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay.Abstractions/Abilities/GetAssetFilePaths.cs/#L8" class="edit-link">Edit this page</a>
253+
</div>
254+
255+
256+
</div>
257+
258+
<div class="affix">
259+
<nav id="affix"></nav>
260+
</div>
261+
</main>
262+
263+
<div class="container-xxl search-results" id="search-results"></div>
264+
265+
<footer class="border-top text-secondary">
266+
<div class="container-xxl">
267+
<div class="flex-fill">
268+
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
269+
</div>
270+
</div>
271+
</footer>
272+
</body>
273+
</html>

‎docs/api/CSF.Screenplay.Abilities.UseAStopwatch.html‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -206,8 +206,8 @@ <h2 class="section" id="methods">Methods
206206

207207
<a id="CSF_Screenplay_Abilities_UseAStopwatch_GetReportFragment_" data-uid="CSF.Screenplay.Abilities.UseAStopwatch.GetReportFragment*"></a>
208208

209-
<h3 id="CSF_Screenplay_Abilities_UseAStopwatch_GetReportFragment_CSF_Screenplay_IHasName_CSF_Screenplay_IFormatsReportFragment_" data-uid="CSF.Screenplay.Abilities.UseAStopwatch.GetReportFragment(CSF.Screenplay.IHasName,CSF.Screenplay.IFormatsReportFragment)">
210-
GetReportFragment(IHasName, IFormatsReportFragment)
209+
<h3 id="CSF_Screenplay_Abilities_UseAStopwatch_GetReportFragment_CSF_Screenplay_Actor_CSF_Screenplay_IFormatsReportFragment_" data-uid="CSF.Screenplay.Abilities.UseAStopwatch.GetReportFragment(CSF.Screenplay.Actor,CSF.Screenplay.IFormatsReportFragment)">
210+
GetReportFragment(Actor, IFormatsReportFragment)
211211
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay.Abstractions/Abilities/UseAStopwatch.cs/#L25"><i class="bi bi-code-slash"></i></a>
212212
</h3>
213213

@@ -217,12 +217,12 @@ <h3 id="CSF_Screenplay_Abilities_UseAStopwatch_GetReportFragment_CSF_Screenplay_
217217
<div class="markdown level1 conceptual"></div>
218218

219219
<div class="codewrapper">
220-
<pre><code class="lang-csharp hljs">public ReportFragment GetReportFragment(IHasName actor, IFormatsReportFragment formatter)</code></pre>
220+
<pre><code class="lang-csharp hljs">public ReportFragment GetReportFragment(Actor actor, IFormatsReportFragment formatter)</code></pre>
221221
</div>
222222

223223
<h4 class="section">Parameters</h4>
224224
<dl class="parameters">
225-
<dt><code>actor</code> <a class="xref" href="CSF.Screenplay.IHasName.html">IHasName</a></dt>
225+
<dt><code>actor</code> <a class="xref" href="CSF.Screenplay.Actor.html">Actor</a></dt>
226226
<dd><p>An actor for whom to write the report fragment</p>
227227
</dd>
228228
<dt><code>formatter</code> <a class="xref" href="CSF.Screenplay.IFormatsReportFragment.html">IFormatsReportFragment</a></dt>
@@ -242,7 +242,7 @@ <h4 class="section">Returns</h4>
242242

243243

244244

245-
<h4 class="section" id="CSF_Screenplay_Abilities_UseAStopwatch_GetReportFragment_CSF_Screenplay_IHasName_CSF_Screenplay_IFormatsReportFragment__examples">Examples</h4>
245+
<h4 class="section" id="CSF_Screenplay_Abilities_UseAStopwatch_GetReportFragment_CSF_Screenplay_Actor_CSF_Screenplay_IFormatsReportFragment__examples">Examples</h4>
246246
<p>
247247
For a performable which clicks a button (where the button itself has been constructor-injected into
248248
the performable instance), then a suitable return value might be a formatted string such as
@@ -260,7 +260,7 @@ <h4 class="section" id="CSF_Screenplay_Abilities_UseAStopwatch_GetReportFragment
260260
</p>
261261

262262

263-
<h4 class="section" id="CSF_Screenplay_Abilities_UseAStopwatch_GetReportFragment_CSF_Screenplay_IHasName_CSF_Screenplay_IFormatsReportFragment__remarks">Remarks</h4>
263+
<h4 class="section" id="CSF_Screenplay_Abilities_UseAStopwatch_GetReportFragment_CSF_Screenplay_Actor_CSF_Screenplay_IFormatsReportFragment__remarks">Remarks</h4>
264264
<div class="markdown level1 remarks"><p>
265265
Implementers should return a string which indicates that the named actor is performing (present tense)
266266
the performable, for types which also implement a performable interface. For types which represent

‎docs/api/CSF.Screenplay.Abilities.html‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,11 @@ <h1 id="CSF_Screenplay_Abilities" data-uid="CSF.Screenplay.Abilities" class="tex
9494
<h3 id="classes">
9595
Classes
9696
</h3>
97+
<dl class="jumplist">
98+
<dt><a class="xref" href="CSF.Screenplay.Abilities.GetAssetFilePaths.html">GetAssetFilePaths</a></dt>
99+
<dd><p>Screenplay ability which gets the file system path for asset files generated by actors participating in the current performance.</p>
100+
</dd>
101+
</dl>
97102
<dl class="jumplist">
98103
<dt><a class="xref" href="CSF.Screenplay.Abilities.UseAStopwatch.html">UseAStopwatch</a></dt>
99104
<dd><p>An ability that enables an actor to make use of a <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.diagnostics.stopwatch">Stopwatch</a> to accurately

‎docs/api/CSF.Screenplay.Actor.html‎

Lines changed: 38 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -153,9 +153,6 @@ <h1 id="CSF_Screenplay_Actor" data-uid="CSF.Screenplay.Actor" class="text-break"
153153
<div>
154154
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
155155
</div>
156-
<div>
157-
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
158-
</div>
159156
</dd></dl>
160157

161158
<dl class="typelist extensionMethods">
@@ -215,6 +212,12 @@ <h1 id="CSF_Screenplay_Actor" data-uid="CSF.Screenplay.Actor" class="text-break"
215212
<div>
216213
<a class="xref" href="CSF.Screenplay.ActorExtensions.html#CSF_Screenplay_ActorExtensions_PerformAsync__1_CSF_Screenplay_ICanPerform_CSF_Screenplay_Performables_IGetsPerformableWithResult___0__System_Threading_CancellationToken_">ActorExtensions.PerformAsync&lt;T&gt;(ICanPerform, IGetsPerformableWithResult&lt;T&gt;, CancellationToken)</a>
217214
</div>
215+
<div>
216+
<a class="xref" href="CSF.Screenplay.ActorExtensions.html#CSF_Screenplay_ActorExtensions_TryGetAbility_CSF_Screenplay_ICanPerform_System_Type_System_Object__">ActorExtensions.TryGetAbility(ICanPerform, Type, out object)</a>
217+
</div>
218+
<div>
219+
<a class="xref" href="CSF.Screenplay.ActorExtensions.html#CSF_Screenplay_ActorExtensions_TryGetAbility__1_CSF_Screenplay_ICanPerform___0__">ActorExtensions.TryGetAbility&lt;T&gt;(ICanPerform, out T)</a>
220+
</div>
218221
<div>
219222
<a class="xref" href="CSF.Screenplay.ActorExtensions.html#CSF_Screenplay_ActorExtensions_HasAbility_CSF_Screenplay_IHasAbilities_System_Type_">ActorExtensions.HasAbility(IHasAbilities, Type)</a>
220223
</div>
@@ -270,7 +273,7 @@ <h2 class="section" id="constructors">Constructors
270273

271274
<h3 id="CSF_Screenplay_Actor__ctor_System_String_System_Guid_" data-uid="CSF.Screenplay.Actor.#ctor(System.String,System.Guid)">
272275
Actor(string, Guid)
273-
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay.Abstractions/Actor.cs/#L69"><i class="bi bi-code-slash"></i></a>
276+
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay.Abstractions/Actor.cs/#L72"><i class="bi bi-code-slash"></i></a>
274277
</h3>
275278

276279
<div class="markdown level1 summary"><p>Initialises a new instance of <a class="xref" href="CSF.Screenplay.Actor.html">Actor</a></p>
@@ -901,6 +904,37 @@ <h4 class="section">Exceptions</h4>
901904

902905

903906

907+
<a id="CSF_Screenplay_Actor_ToString_" data-uid="CSF.Screenplay.Actor.ToString*"></a>
908+
909+
<h3 id="CSF_Screenplay_Actor_ToString" data-uid="CSF.Screenplay.Actor.ToString">
910+
ToString()
911+
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay.Abstractions/Actor.cs/#L62"><i class="bi bi-code-slash"></i></a>
912+
</h3>
913+
914+
<div class="markdown level1 summary"></div>
915+
<div class="markdown level1 conceptual"></div>
916+
917+
<div class="codewrapper">
918+
<pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
919+
</div>
920+
921+
922+
<h4 class="section">Returns</h4>
923+
<dl class="parameters">
924+
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
925+
<dd></dd>
926+
</dl>
927+
928+
929+
930+
931+
932+
933+
934+
935+
936+
937+
904938
<h2 class="section" id="events">Events
905939
</h2>
906940

0 commit comments

Comments
 (0)