Class PerformableAsset

Namespace

CSF.Screenplay.ReportModel

Assembly

CSF.Screenplay.dll

Model represents a single asset which was recorded from a performable.

public class PerformableAsset

Inheritance

object

PerformableAsset

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Assets are typically files which are saved to disk, containing arbitrary information, recorded by a performable. This might be a screenshot, some generated content or diagnostic information. Its real content is arbitrary and down to the implementation.

Every asset has one or two properties in common, the Name and optionally Summary. The data for the asset file is then described by one of two ways:

• The content of the asset is located on disk at a path indicated by Path
• The content of the asset is embedded within this model as base64-encoded text, within Data

Typically when reports are first created, for expedience, assets are recorded to disk as files. However, for portability, it is often useful to embed the asset data within the report so that the entire report may be transported as a single file.

Properties

ContentType

Gets the content type (aka MIME type) of the asset.

public string ContentType { get; set; }

Property Value

string

Data

Gets or sets base64-encoded data which contains the data for the asset.

public string Data { get; set; }

Property Value

string

Name

Gets or sets the name of the asset file, including its extension.

public string Name { get; set; }

Property Value

string

Path

Gets or sets a full/absolute path to the asset file.

public string Path { get; set; }

Property Value

string

Summary

Gets or sets an optional human-readable summary of what this asset represents. This should be one sentence at most, suitable for display in a UI tool-tip.

public string Summary { get; set; }

Property Value

string