Class GetAssetFilePaths

Namespace

CSF.Screenplay.Abilities

Assembly

CSF.Screenplay.Abstractions.dll

Screenplay ability which gets the file system path for asset files generated by actors participating in the current performance.

public class GetAssetFilePaths

Inheritance

object

GetAssetFilePaths

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

GetAssetFilePaths(IGetsAssetFilePath)

Initializes a new instance of the GetAssetFilePaths class.

public GetAssetFilePaths(IGetsAssetFilePath pathProvider)

Parameters

pathProvider IGetsAssetFilePath

The path provider used to get asset file paths.

Methods

GetAssetFilePath(string)

Gets the file system path for the specified asset file.

public string GetAssetFilePath(string baseName)

Parameters

baseName string

A short descriptive file name fragment for the asset file, including the file extension.

Returns

string

The asset file path.

Remarks

The returned file system path is an absolute path to which the asset file should be written. The path is determined by the logic of the service IGetsAssetFilePath. This means that the final filename will not be identical to the baseName but will include that base name within it.

If this method returns null then the asset file should not be written to the file system.

See Also

GetAssetFilePath(string)