Interface IGetsAssetFilePath
- Namespace
- CSF.Screenplay.Reporting
- Assembly
- CSF.Screenplay.Abstractions.dll
A service which gets a filesystem path to which Screenplay asset files should be written, if they are to be written at all.
public interface IGetsAssetFilePathMethods
GetAssetFilePath(string)
Gets the filesystem path to which an asset file should be written.
string GetAssetFilePath(string baseName)Parameters
baseNamestringA short & descriptive filename fragment, which includes the file extension but no path information
Returns
- string
An absolute file system path at which the asset file should be saved, or a null reference indicating that the asset file should not be saved.
Remarks
If reporting is disabled, for the same reasons as GetReportPath() would return null, then this method will also return null. In that case, reporting is disabled and no asset files should be written to the file system.
If reporting is enabled, then this method should return an absolute file system path to which an asset file should be written, where the asset has the specified 'base name'. That base name should be a short filename fragment which describes the asset. This file name will be embellished with other information by this method, such as to ensure that the file name is unique within the current Screenplay run.