Class ReportPathProviderExtensions

Namespace

CSF.Screenplay.Reporting

Assembly

CSF.Screenplay.Abstractions.dll

Extension methods for IGetsReportPath.

public static class ReportPathProviderExtensions

Inheritance

object

ReportPathProviderExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

GetReportFilePath(IGetsReportPath)

Gets the file path to which the report JSON file should be written.

public static string GetReportFilePath(this IGetsReportPath provider)

Parameters

provider IGetsReportPath

Returns

string

The report file path.

Remarks

If the returned path is null then Screenplay's reporting functionality should be disabled and no report should be written. Otherwise, implementations of this interface should return an absolute file system path to which the report JSON file should be written. This path must be writable by the executing process.

Reporting could be disabled if either the Screenplay Options report path is null or a whitespace-only string, or if the path indicated by those options is not writable.