From cf39ca08fd706ce6b1bcc57317b22accd1a08fce Mon Sep 17 00:00:00 2001 From: "Appveyor (on behalf of Craig Fowler)" Date: Mon, 16 Sep 2024 19:46:40 +0000 Subject: [PATCH] Auto: Updates to docs website via CI [skip ci] --- docs/api/CSF.Screenplay.Actors.Cast.html | 2 +- ...Performances.IRelaysPerformanceEvents.html | 64 +++++++++++++++++-- ...play.Performances.PerformanceEventBus.html | 64 +++++++++++++++++-- docs/api/CSF.Screenplay.ScreenplayPlugin.html | 42 ++++++++++++ docs/index.json | 6 +- docs/xrefmap.yml | 45 +++++++++++++ 6 files changed, 207 insertions(+), 16 deletions(-) diff --git a/docs/api/CSF.Screenplay.Actors.Cast.html b/docs/api/CSF.Screenplay.Actors.Cast.html index bad2845..dc833a4 100644 --- a/docs/api/CSF.Screenplay.Actors.Cast.html +++ b/docs/api/CSF.Screenplay.Actors.Cast.html @@ -169,7 +169,7 @@

Constructors

Cast(IServiceProvider, Guid) - +

Initialises a new instance of Cast.

diff --git a/docs/api/CSF.Screenplay.Performances.IRelaysPerformanceEvents.html b/docs/api/CSF.Screenplay.Performances.IRelaysPerformanceEvents.html index ba90a4b..613994a 100644 --- a/docs/api/CSF.Screenplay.Performances.IRelaysPerformanceEvents.html +++ b/docs/api/CSF.Screenplay.Performances.IRelaysPerformanceEvents.html @@ -174,7 +174,7 @@

Parameters

InvokeActorSpotlit(string, Guid) - +

Invokes an event indicating that an Actor has been placed into the Spotlight of an IStage.

@@ -206,11 +206,63 @@

Parameters

+ + +

+ InvokeGainedAbility(string, Guid, object) + +

+ +

Invokes an event indicating that a new Actor has gained an ability.

+
+
+ +
+ 
void InvokeGainedAbility(string actorName, Guid performanceIdentity, object ability)
+
+ +

Parameters

+
+
actorName string
+

The actor's human-readable name.

+
+
performanceIdentity Guid
+

A unique identifier for the current IPerformance.

+
+
ability object
+

The ability that the actor has gained.

+
+
+ + + + + + + + +

Remarks

+

+Use this method only when an actor gains one or more abilities before the the SubscribeTo(Actor) method +has been used to subscribe to the actor. Once the actor has been subscribed-to by an implementation of this instance, +their newly-added abilities will automatically be captured. +

+

+In some circumstances where the actor is fully created and has their abilities granted BEFORE there has been an opportunity +to subscribe to them, then this method is required to retrospectively trigger the abilitiy-granted event. +This is applicable for actors who are created by an IPersona, which might grant the actors one or more abilities +immediately, as part of their creation. +

+
+ + + +

InvokePerformanceBegun(Guid, IList<IdentifierAndName>) - +

Invokes an event indicating that a IPerformance has begun.

@@ -246,7 +298,7 @@

Parameters

InvokePerformanceFinished(Guid, IList<IdentifierAndName>, bool?) - +

Invokes an event indicating that a IPerformance has finished.

@@ -285,7 +337,7 @@

Parameters

InvokeScreenplayEnded() - +

Invokes an event indicating that a Screenplay has ended.

@@ -312,7 +364,7 @@

InvokeScreenplayStarted() - +

Invokes an event indicating that a Screenplay has started.

@@ -339,7 +391,7 @@

InvokeSpotlightTurnedOff(Guid) - +

Invokes an event indicating that the Spotlight of the IStage has been 'turned off'.

diff --git a/docs/api/CSF.Screenplay.Performances.PerformanceEventBus.html b/docs/api/CSF.Screenplay.Performances.PerformanceEventBus.html index 9f8b30b..3a1cd57 100644 --- a/docs/api/CSF.Screenplay.Performances.PerformanceEventBus.html +++ b/docs/api/CSF.Screenplay.Performances.PerformanceEventBus.html @@ -218,7 +218,7 @@

Parameters

InvokeActorSpotlit(string, Guid) - +

Invokes an event indicating that an Actor has been placed into the Spotlight of an IStage.

@@ -250,11 +250,63 @@

Parameters

+ + +

+ InvokeGainedAbility(string, Guid, object) + +

+ +

Invokes an event indicating that a new Actor has gained an ability.

+
+
+ +
+ 
public void InvokeGainedAbility(string actorName, Guid performanceIdentity, object ability)
+
+ +

Parameters

+
+
actorName string
+

The actor's human-readable name.

+
+
performanceIdentity Guid
+

A unique identifier for the current IPerformance.

+
+
ability object
+

The ability that the actor has gained.

+
+
+ + + + + + + + +

Remarks

+

+Use this method only when an actor gains one or more abilities before the the SubscribeTo(Actor) method +has been used to subscribe to the actor. Once the actor has been subscribed-to by an implementation of this instance, +their newly-added abilities will automatically be captured. +

+

+In some circumstances where the actor is fully created and has their abilities granted BEFORE there has been an opportunity +to subscribe to them, then this method is required to retrospectively trigger the abilitiy-granted event. +This is applicable for actors who are created by an IPersona, which might grant the actors one or more abilities +immediately, as part of their creation. +

+
+ + + +

InvokePerformanceBegun(Guid, IList<IdentifierAndName>) - +

Invokes an event indicating that a IPerformance has begun.

@@ -290,7 +342,7 @@

Parameters

InvokePerformanceFinished(Guid, IList<IdentifierAndName>, bool?) - +

Invokes an event indicating that a IPerformance has finished.

@@ -329,7 +381,7 @@

Parameters

InvokeScreenplayEnded() - +

Invokes an event indicating that a Screenplay has ended.

@@ -356,7 +408,7 @@

InvokeScreenplayStarted() - +

Invokes an event indicating that a Screenplay has started.

@@ -383,7 +435,7 @@

InvokeSpotlightTurnedOff(Guid) - +

Invokes an event indicating that the Spotlight of the IStage has been 'turned off'.

diff --git a/docs/api/CSF.Screenplay.ScreenplayPlugin.html b/docs/api/CSF.Screenplay.ScreenplayPlugin.html index ae542ff..0aa7113 100644 --- a/docs/api/CSF.Screenplay.ScreenplayPlugin.html +++ b/docs/api/CSF.Screenplay.ScreenplayPlugin.html @@ -178,6 +178,48 @@

Remarks

+

Properties +

+ + + + +

+ Screenplay + +

+ +

Provides static access to the Screenplay instance.

+
+
+ +
+ 
public static Screenplay Screenplay { get; }
+
+ + + + + +

Property Value

+
+
Screenplay
+
+
+ + + + +

Remarks

+

+This is required because the bindings for beginning/ending the Screenplay in ScreenplayBinding must be static: +https://docs.specflow.org/projects/specflow/en/latest/Bindings/Hooks.html#supported-hook-attributes. +

+
+ + + +

Methods

diff --git a/docs/index.json b/docs/index.json index 4b65de8..38ae28d 100644 --- a/docs/index.json +++ b/docs/index.json @@ -262,7 +262,7 @@ "api/CSF.Screenplay.Performances.IRelaysPerformanceEvents.html": { "href": "api/CSF.Screenplay.Performances.IRelaysPerformanceEvents.html", "title": "Interface IRelaysPerformanceEvents | Screenplay docs", - "keywords": "Interface IRelaysPerformanceEvents Namespace CSF.Screenplay.Performances Assembly CSF.Screenplay.Abstractions.dll An object which can relay events that relate to a IPerformance public interface IRelaysPerformanceEvents Remarks This object is used as an event sink; a single point of contact to which many objects may send events. This allows event consumers to receive events from many origins by subscribing to only a single object. There should only be a single instance of an object which implements this interface, for the lifetime of a Screenplay. This type is closely related to IHasPerformanceEvents. This is the event sink and IHasPerformanceEvents is the publisher of those events. Despite this, their APIs are not symmetrical, as many of the events published are derived by subscribing to an Actor instance. Methods InvokeActorCreated(string, Guid) Invokes an event indicating that a new Actor has been created and added to the IPerformance. void InvokeActorCreated(string actorName, Guid performanceIdentity) Parameters actorName string The actor's human-readable name. performanceIdentity Guid A unique identifier for the current IPerformance. InvokeActorSpotlit(string, Guid) Invokes an event indicating that an Actor has been placed into the Spotlight of an IStage. void InvokeActorSpotlit(string actorName, Guid performanceIdentity) Parameters actorName string The actor's human-readable name. performanceIdentity Guid A unique identifier for the current IPerformance. InvokePerformanceBegun(Guid, IList) Invokes an event indicating that a IPerformance has begun. void InvokePerformanceBegun(Guid performanceIdentity, IList namingHierarchy) Parameters performanceIdentity Guid The performance identity namingHierarchy IList The performance's hierarchical name InvokePerformanceFinished(Guid, IList, bool?) Invokes an event indicating that a IPerformance has finished. void InvokePerformanceFinished(Guid performanceIdentity, IList namingHierarchy, bool? success) Parameters performanceIdentity Guid The performance identity namingHierarchy IList The performance's hierarchical name success bool? A value indicating whether or not the performance was a success InvokeScreenplayEnded() Invokes an event indicating that a Screenplay has ended. void InvokeScreenplayEnded() InvokeScreenplayStarted() Invokes an event indicating that a Screenplay has started. void InvokeScreenplayStarted() InvokeSpotlightTurnedOff(Guid) Invokes an event indicating that the Spotlight of the IStage has been 'turned off'. void InvokeSpotlightTurnedOff(Guid performanceIdentity) Parameters performanceIdentity Guid A unique identifier for the current IPerformance. SubscribeTo(Actor) Subscribes to (and relays) events from the specified actor. void SubscribeTo(Actor actor) Parameters actor Actor The actor to which this relay should subscribe. UnsubscribeFrom(Actor) Unsubscribes from events from the specified actor. void UnsubscribeFrom(Actor actor) Parameters actor Actor The actor from which this relay should unsubscribe. Remarks This method is typically used when the actor instance is about to be disposed, such as at the end of a IPerformance. UnsubscribeFromAllActors(Guid) Unsubscribes from all of the events for all of the actors who are part of the the IPerformance, indicated by its identity. void UnsubscribeFromAllActors(Guid performanceIdentity) Parameters performanceIdentity Guid The identity of a performance. Remarks Using this method is equivalent to calling UnsubscribeFrom(Actor) for every Actor which is participating in the specified performance. Use this method when ending a performance, as a convenience to unsubscribe from all of its actors at once. See Also IHasPerformanceEvents" + "keywords": "Interface IRelaysPerformanceEvents Namespace CSF.Screenplay.Performances Assembly CSF.Screenplay.Abstractions.dll An object which can relay events that relate to a IPerformance public interface IRelaysPerformanceEvents Remarks This object is used as an event sink; a single point of contact to which many objects may send events. This allows event consumers to receive events from many origins by subscribing to only a single object. There should only be a single instance of an object which implements this interface, for the lifetime of a Screenplay. This type is closely related to IHasPerformanceEvents. This is the event sink and IHasPerformanceEvents is the publisher of those events. Despite this, their APIs are not symmetrical, as many of the events published are derived by subscribing to an Actor instance. Methods InvokeActorCreated(string, Guid) Invokes an event indicating that a new Actor has been created and added to the IPerformance. void InvokeActorCreated(string actorName, Guid performanceIdentity) Parameters actorName string The actor's human-readable name. performanceIdentity Guid A unique identifier for the current IPerformance. InvokeActorSpotlit(string, Guid) Invokes an event indicating that an Actor has been placed into the Spotlight of an IStage. void InvokeActorSpotlit(string actorName, Guid performanceIdentity) Parameters actorName string The actor's human-readable name. performanceIdentity Guid A unique identifier for the current IPerformance. InvokeGainedAbility(string, Guid, object) Invokes an event indicating that a new Actor has gained an ability. void InvokeGainedAbility(string actorName, Guid performanceIdentity, object ability) Parameters actorName string The actor's human-readable name. performanceIdentity Guid A unique identifier for the current IPerformance. ability object The ability that the actor has gained. Remarks Use this method only when an actor gains one or more abilities before the the SubscribeTo(Actor) method has been used to subscribe to the actor. Once the actor has been subscribed-to by an implementation of this instance, their newly-added abilities will automatically be captured. In some circumstances where the actor is fully created and has their abilities granted BEFORE there has been an opportunity to subscribe to them, then this method is required to retrospectively trigger the abilitiy-granted event. This is applicable for actors who are created by an IPersona, which might grant the actors one or more abilities immediately, as part of their creation. InvokePerformanceBegun(Guid, IList) Invokes an event indicating that a IPerformance has begun. void InvokePerformanceBegun(Guid performanceIdentity, IList namingHierarchy) Parameters performanceIdentity Guid The performance identity namingHierarchy IList The performance's hierarchical name InvokePerformanceFinished(Guid, IList, bool?) Invokes an event indicating that a IPerformance has finished. void InvokePerformanceFinished(Guid performanceIdentity, IList namingHierarchy, bool? success) Parameters performanceIdentity Guid The performance identity namingHierarchy IList The performance's hierarchical name success bool? A value indicating whether or not the performance was a success InvokeScreenplayEnded() Invokes an event indicating that a Screenplay has ended. void InvokeScreenplayEnded() InvokeScreenplayStarted() Invokes an event indicating that a Screenplay has started. void InvokeScreenplayStarted() InvokeSpotlightTurnedOff(Guid) Invokes an event indicating that the Spotlight of the IStage has been 'turned off'. void InvokeSpotlightTurnedOff(Guid performanceIdentity) Parameters performanceIdentity Guid A unique identifier for the current IPerformance. SubscribeTo(Actor) Subscribes to (and relays) events from the specified actor. void SubscribeTo(Actor actor) Parameters actor Actor The actor to which this relay should subscribe. UnsubscribeFrom(Actor) Unsubscribes from events from the specified actor. void UnsubscribeFrom(Actor actor) Parameters actor Actor The actor from which this relay should unsubscribe. Remarks This method is typically used when the actor instance is about to be disposed, such as at the end of a IPerformance. UnsubscribeFromAllActors(Guid) Unsubscribes from all of the events for all of the actors who are part of the the IPerformance, indicated by its identity. void UnsubscribeFromAllActors(Guid performanceIdentity) Parameters performanceIdentity Guid The identity of a performance. Remarks Using this method is equivalent to calling UnsubscribeFrom(Actor) for every Actor which is participating in the specified performance. Use this method when ending a performance, as a convenience to unsubscribe from all of its actors at once. See Also IHasPerformanceEvents" }, "api/CSF.Screenplay.Performances.IdentifierAndName.html": { "href": "api/CSF.Screenplay.Performances.IdentifierAndName.html", @@ -277,7 +277,7 @@ "api/CSF.Screenplay.Performances.PerformanceEventBus.html": { "href": "api/CSF.Screenplay.Performances.PerformanceEventBus.html", "title": "Class PerformanceEventBus | Screenplay docs", - "keywords": "Class PerformanceEventBus Namespace CSF.Screenplay.Performances Assembly CSF.Screenplay.dll Implementation of an event bus for performance-related events. public class PerformanceEventBus : IHasPerformanceEvents, IRelaysPerformanceEvents Inheritance object PerformanceEventBus Implements IHasPerformanceEvents IRelaysPerformanceEvents Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Remarks This object should be used as a singleton across the lifetime of a Screenplay. As an event bus object, it is both a subscriber (a sink) which can receive events. It is also a publisher, which emits events. The purpose of this object is to aggregate events from many instances of Performance and Actor over the duration/lifetime of the Screenplay. This way, consumers have only a single object to which they should subscribe in order to receive those events. As you will see from the API of this object, the implementations of IHasPerformanceEvents and IRelaysPerformanceEvents are not symmetrical. Many events are published by subscribing to the events upon an Actor. Methods InvokeActorCreated(string, Guid) Invokes an event indicating that a new Actor has been created and added to the IPerformance. public void InvokeActorCreated(string actorName, Guid performanceIdentity) Parameters actorName string The actor's human-readable name. performanceIdentity Guid A unique identifier for the current IPerformance. InvokeActorSpotlit(string, Guid) Invokes an event indicating that an Actor has been placed into the Spotlight of an IStage. public void InvokeActorSpotlit(string actorName, Guid performanceIdentity) Parameters actorName string The actor's human-readable name. performanceIdentity Guid A unique identifier for the current IPerformance. InvokePerformanceBegun(Guid, IList) Invokes an event indicating that a IPerformance has begun. public void InvokePerformanceBegun(Guid performanceIdentity, IList namingHierarchy) Parameters performanceIdentity Guid The performance identity namingHierarchy IList The performance's hierarchical name InvokePerformanceFinished(Guid, IList, bool?) Invokes an event indicating that a IPerformance has finished. public void InvokePerformanceFinished(Guid performanceIdentity, IList namingHierarchy, bool? success) Parameters performanceIdentity Guid The performance identity namingHierarchy IList The performance's hierarchical name success bool? A value indicating whether or not the performance was a success InvokeScreenplayEnded() Invokes an event indicating that a Screenplay has ended. public void InvokeScreenplayEnded() InvokeScreenplayStarted() Invokes an event indicating that a Screenplay has started. public void InvokeScreenplayStarted() InvokeSpotlightTurnedOff(Guid) Invokes an event indicating that the Spotlight of the IStage has been 'turned off'. public void InvokeSpotlightTurnedOff(Guid performanceIdentity) Parameters performanceIdentity Guid A unique identifier for the current IPerformance. SubscribeTo(Actor) Subscribes to (and relays) events from the specified actor. public void SubscribeTo(Actor actor) Parameters actor Actor The actor to which this relay should subscribe. UnsubscribeFrom(Actor) Unsubscribes from events from the specified actor. public void UnsubscribeFrom(Actor actor) Parameters actor Actor The actor from which this relay should unsubscribe. Remarks This method is typically used when the actor instance is about to be disposed, such as at the end of a IPerformance. UnsubscribeFromAllActors(Guid) Unsubscribes from all of the events for all of the actors who are part of the the IPerformance, indicated by its identity. public void UnsubscribeFromAllActors(Guid performanceIdentity) Parameters performanceIdentity Guid The identity of a performance. Remarks Using this method is equivalent to calling UnsubscribeFrom(Actor) for every Actor which is participating in the specified performance. Use this method when ending a performance, as a convenience to unsubscribe from all of its actors at once. Events ActorCreated Occurs when a new Actor is created and added to the IPerformance. public event EventHandler ActorCreated Event Type EventHandler ActorSpotlit Occurs when an Actor is placed into the Spotlight of an IStage. public event EventHandler ActorSpotlit Event Type EventHandler BeginPerformable Occurs when an Actor begins the execution of a performable object. public event EventHandler BeginPerformable Event Type EventHandler EndPerformable Occurs when an Actor ends the execution of a performable object. public event EventHandler EndPerformable Event Type EventHandler GainedAbility Occurs when an Actor gains a new ability. public event EventHandler GainedAbility Event Type EventHandler PerformableFailed Occurs when a performable object fails with an exception. public event EventHandler PerformableFailed Event Type EventHandler PerformableResult Occurs when an Actor receives a result from a perfperformable objectrmance. public event EventHandler PerformableResult Event Type EventHandler PerformanceBegun Occurs when a IPerformance begins executing. public event EventHandler PerformanceBegun Event Type EventHandler PerformanceFinished Occurs when a IPerformance has finished executing. public event EventHandler PerformanceFinished Event Type EventHandler ScreenplayEnded Occurs when a Screenplay has ended. public event EventHandler ScreenplayEnded Event Type EventHandler ScreenplayStarted Occurs when a Screenplay starts. public event EventHandler ScreenplayStarted Event Type EventHandler SpotlightTurnedOff Occurs when the Spotlight of an IStage is 'turned off'; the Actor who is currently spotlit is removed without being replaced. public event EventHandler SpotlightTurnedOff Event Type EventHandler" + "keywords": "Class PerformanceEventBus Namespace CSF.Screenplay.Performances Assembly CSF.Screenplay.dll Implementation of an event bus for performance-related events. public class PerformanceEventBus : IHasPerformanceEvents, IRelaysPerformanceEvents Inheritance object PerformanceEventBus Implements IHasPerformanceEvents IRelaysPerformanceEvents Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Remarks This object should be used as a singleton across the lifetime of a Screenplay. As an event bus object, it is both a subscriber (a sink) which can receive events. It is also a publisher, which emits events. The purpose of this object is to aggregate events from many instances of Performance and Actor over the duration/lifetime of the Screenplay. This way, consumers have only a single object to which they should subscribe in order to receive those events. As you will see from the API of this object, the implementations of IHasPerformanceEvents and IRelaysPerformanceEvents are not symmetrical. Many events are published by subscribing to the events upon an Actor. Methods InvokeActorCreated(string, Guid) Invokes an event indicating that a new Actor has been created and added to the IPerformance. public void InvokeActorCreated(string actorName, Guid performanceIdentity) Parameters actorName string The actor's human-readable name. performanceIdentity Guid A unique identifier for the current IPerformance. InvokeActorSpotlit(string, Guid) Invokes an event indicating that an Actor has been placed into the Spotlight of an IStage. public void InvokeActorSpotlit(string actorName, Guid performanceIdentity) Parameters actorName string The actor's human-readable name. performanceIdentity Guid A unique identifier for the current IPerformance. InvokeGainedAbility(string, Guid, object) Invokes an event indicating that a new Actor has gained an ability. public void InvokeGainedAbility(string actorName, Guid performanceIdentity, object ability) Parameters actorName string The actor's human-readable name. performanceIdentity Guid A unique identifier for the current IPerformance. ability object The ability that the actor has gained. Remarks Use this method only when an actor gains one or more abilities before the the SubscribeTo(Actor) method has been used to subscribe to the actor. Once the actor has been subscribed-to by an implementation of this instance, their newly-added abilities will automatically be captured. In some circumstances where the actor is fully created and has their abilities granted BEFORE there has been an opportunity to subscribe to them, then this method is required to retrospectively trigger the abilitiy-granted event. This is applicable for actors who are created by an IPersona, which might grant the actors one or more abilities immediately, as part of their creation. InvokePerformanceBegun(Guid, IList) Invokes an event indicating that a IPerformance has begun. public void InvokePerformanceBegun(Guid performanceIdentity, IList namingHierarchy) Parameters performanceIdentity Guid The performance identity namingHierarchy IList The performance's hierarchical name InvokePerformanceFinished(Guid, IList, bool?) Invokes an event indicating that a IPerformance has finished. public void InvokePerformanceFinished(Guid performanceIdentity, IList namingHierarchy, bool? success) Parameters performanceIdentity Guid The performance identity namingHierarchy IList The performance's hierarchical name success bool? A value indicating whether or not the performance was a success InvokeScreenplayEnded() Invokes an event indicating that a Screenplay has ended. public void InvokeScreenplayEnded() InvokeScreenplayStarted() Invokes an event indicating that a Screenplay has started. public void InvokeScreenplayStarted() InvokeSpotlightTurnedOff(Guid) Invokes an event indicating that the Spotlight of the IStage has been 'turned off'. public void InvokeSpotlightTurnedOff(Guid performanceIdentity) Parameters performanceIdentity Guid A unique identifier for the current IPerformance. SubscribeTo(Actor) Subscribes to (and relays) events from the specified actor. public void SubscribeTo(Actor actor) Parameters actor Actor The actor to which this relay should subscribe. UnsubscribeFrom(Actor) Unsubscribes from events from the specified actor. public void UnsubscribeFrom(Actor actor) Parameters actor Actor The actor from which this relay should unsubscribe. Remarks This method is typically used when the actor instance is about to be disposed, such as at the end of a IPerformance. UnsubscribeFromAllActors(Guid) Unsubscribes from all of the events for all of the actors who are part of the the IPerformance, indicated by its identity. public void UnsubscribeFromAllActors(Guid performanceIdentity) Parameters performanceIdentity Guid The identity of a performance. Remarks Using this method is equivalent to calling UnsubscribeFrom(Actor) for every Actor which is participating in the specified performance. Use this method when ending a performance, as a convenience to unsubscribe from all of its actors at once. Events ActorCreated Occurs when a new Actor is created and added to the IPerformance. public event EventHandler ActorCreated Event Type EventHandler ActorSpotlit Occurs when an Actor is placed into the Spotlight of an IStage. public event EventHandler ActorSpotlit Event Type EventHandler BeginPerformable Occurs when an Actor begins the execution of a performable object. public event EventHandler BeginPerformable Event Type EventHandler EndPerformable Occurs when an Actor ends the execution of a performable object. public event EventHandler EndPerformable Event Type EventHandler GainedAbility Occurs when an Actor gains a new ability. public event EventHandler GainedAbility Event Type EventHandler PerformableFailed Occurs when a performable object fails with an exception. public event EventHandler PerformableFailed Event Type EventHandler PerformableResult Occurs when an Actor receives a result from a perfperformable objectrmance. public event EventHandler PerformableResult Event Type EventHandler PerformanceBegun Occurs when a IPerformance begins executing. public event EventHandler PerformanceBegun Event Type EventHandler PerformanceFinished Occurs when a IPerformance has finished executing. public event EventHandler PerformanceFinished Event Type EventHandler ScreenplayEnded Occurs when a Screenplay has ended. public event EventHandler ScreenplayEnded Event Type EventHandler ScreenplayStarted Occurs when a Screenplay starts. public event EventHandler ScreenplayStarted Event Type EventHandler SpotlightTurnedOff Occurs when the Spotlight of an IStage is 'turned off'; the Actor who is currently spotlit is removed without being replaced. public event EventHandler SpotlightTurnedOff Event Type EventHandler" }, "api/CSF.Screenplay.Performances.PerformanceFactory.html": { "href": "api/CSF.Screenplay.Performances.PerformanceFactory.html", @@ -342,7 +342,7 @@ "api/CSF.Screenplay.ScreenplayPlugin.html": { "href": "api/CSF.Screenplay.ScreenplayPlugin.html", "title": "Class ScreenplayPlugin | Screenplay docs", - "keywords": "Class ScreenplayPlugin Namespace CSF.Screenplay Assembly CSF.Screenplay.SpecFlowPlugin.dll The Screenplay plugin for SpecFlow. public class ScreenplayPlugin : IRuntimePlugin Inheritance object ScreenplayPlugin Implements IRuntimePlugin Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Remarks This plugin class is the test framework integration for SpecFlow. Crucially it adds the Screenplay architecture to the SpecFlow architecture. Becuase this plugin leverages the SpecFlow/BoDi IObjectContainer, it is likely incompatible with other plugins which integrate with third party Dependency Injection libraries. This may be easily worked-around, though. If you are using a third-party DI plugin then do not use this plugin. Instead use the AddScreenplay(IServiceCollection) method to add Screenplay to that third-party DI system, when customising the dependency registrations. Adding Screenplay in that way is equivalent to the work done by this plugin. If you wish to further customise the dependency injection, such as adding injectable services for abilities or implementations of IPersona, add them to the relevant DI container. When using SpecFlow's default BoDi container this is described in the following article https://docs.specflow.org/projects/specflow/en/latest/Bindings/Context-Injection.html#advanced-options. If using a third-party DI container then you should use that container's appropriate mechanism of adding services. Methods Initialize(RuntimePluginEvents, RuntimePluginParameters, UnitTestProviderConfiguration) public void Initialize(RuntimePluginEvents runtimePluginEvents, RuntimePluginParameters runtimePluginParameters, UnitTestProviderConfiguration unitTestProviderConfiguration) Parameters runtimePluginEvents RuntimePluginEvents runtimePluginParameters RuntimePluginParameters unitTestProviderConfiguration UnitTestProviderConfiguration" + "keywords": "Class ScreenplayPlugin Namespace CSF.Screenplay Assembly CSF.Screenplay.SpecFlowPlugin.dll The Screenplay plugin for SpecFlow. public class ScreenplayPlugin : IRuntimePlugin Inheritance object ScreenplayPlugin Implements IRuntimePlugin Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Remarks This plugin class is the test framework integration for SpecFlow. Crucially it adds the Screenplay architecture to the SpecFlow architecture. Becuase this plugin leverages the SpecFlow/BoDi IObjectContainer, it is likely incompatible with other plugins which integrate with third party Dependency Injection libraries. This may be easily worked-around, though. If you are using a third-party DI plugin then do not use this plugin. Instead use the AddScreenplay(IServiceCollection) method to add Screenplay to that third-party DI system, when customising the dependency registrations. Adding Screenplay in that way is equivalent to the work done by this plugin. If you wish to further customise the dependency injection, such as adding injectable services for abilities or implementations of IPersona, add them to the relevant DI container. When using SpecFlow's default BoDi container this is described in the following article https://docs.specflow.org/projects/specflow/en/latest/Bindings/Context-Injection.html#advanced-options. If using a third-party DI container then you should use that container's appropriate mechanism of adding services. Properties Screenplay Provides static access to the Screenplay instance. public static Screenplay Screenplay { get; } Property Value Screenplay Remarks This is required because the bindings for beginning/ending the Screenplay in ScreenplayBinding must be static: https://docs.specflow.org/projects/specflow/en/latest/Bindings/Hooks.html#supported-hook-attributes. Methods Initialize(RuntimePluginEvents, RuntimePluginParameters, UnitTestProviderConfiguration) public void Initialize(RuntimePluginEvents runtimePluginEvents, RuntimePluginParameters runtimePluginParameters, UnitTestProviderConfiguration unitTestProviderConfiguration) Parameters runtimePluginEvents RuntimePluginEvents runtimePluginParameters RuntimePluginParameters unitTestProviderConfiguration UnitTestProviderConfiguration" }, "api/CSF.Screenplay.ScreenplayServiceCollectionExtensions.html": { "href": "api/CSF.Screenplay.ScreenplayServiceCollectionExtensions.html", diff --git a/docs/xrefmap.yml b/docs/xrefmap.yml index 257ad46..4e21f3f 100644 --- a/docs/xrefmap.yml +++ b/docs/xrefmap.yml @@ -2370,6 +2370,22 @@ references: isSpec: "True" fullName: CSF.Screenplay.Performances.IRelaysPerformanceEvents.InvokeActorSpotlit nameWithType: IRelaysPerformanceEvents.InvokeActorSpotlit +- uid: CSF.Screenplay.Performances.IRelaysPerformanceEvents.InvokeGainedAbility(System.String,System.Guid,System.Object) + name: InvokeGainedAbility(string, Guid, object) + href: api/CSF.Screenplay.Performances.IRelaysPerformanceEvents.html#CSF_Screenplay_Performances_IRelaysPerformanceEvents_InvokeGainedAbility_System_String_System_Guid_System_Object_ + commentId: M:CSF.Screenplay.Performances.IRelaysPerformanceEvents.InvokeGainedAbility(System.String,System.Guid,System.Object) + name.vb: InvokeGainedAbility(String, Guid, Object) + fullName: CSF.Screenplay.Performances.IRelaysPerformanceEvents.InvokeGainedAbility(string, System.Guid, object) + fullName.vb: CSF.Screenplay.Performances.IRelaysPerformanceEvents.InvokeGainedAbility(String, System.Guid, Object) + nameWithType: IRelaysPerformanceEvents.InvokeGainedAbility(string, Guid, object) + nameWithType.vb: IRelaysPerformanceEvents.InvokeGainedAbility(String, Guid, Object) +- uid: CSF.Screenplay.Performances.IRelaysPerformanceEvents.InvokeGainedAbility* + name: InvokeGainedAbility + href: api/CSF.Screenplay.Performances.IRelaysPerformanceEvents.html#CSF_Screenplay_Performances_IRelaysPerformanceEvents_InvokeGainedAbility_ + commentId: Overload:CSF.Screenplay.Performances.IRelaysPerformanceEvents.InvokeGainedAbility + isSpec: "True" + fullName: CSF.Screenplay.Performances.IRelaysPerformanceEvents.InvokeGainedAbility + nameWithType: IRelaysPerformanceEvents.InvokeGainedAbility - uid: CSF.Screenplay.Performances.IRelaysPerformanceEvents.InvokePerformanceBegun(System.Guid,System.Collections.Generic.IList{CSF.Screenplay.Performances.IdentifierAndName}) name: InvokePerformanceBegun(Guid, IList) href: api/CSF.Screenplay.Performances.IRelaysPerformanceEvents.html#CSF_Screenplay_Performances_IRelaysPerformanceEvents_InvokePerformanceBegun_System_Guid_System_Collections_Generic_IList_CSF_Screenplay_Performances_IdentifierAndName__ @@ -2698,6 +2714,22 @@ references: isSpec: "True" fullName: CSF.Screenplay.Performances.PerformanceEventBus.InvokeActorSpotlit nameWithType: PerformanceEventBus.InvokeActorSpotlit +- uid: CSF.Screenplay.Performances.PerformanceEventBus.InvokeGainedAbility(System.String,System.Guid,System.Object) + name: InvokeGainedAbility(string, Guid, object) + href: api/CSF.Screenplay.Performances.PerformanceEventBus.html#CSF_Screenplay_Performances_PerformanceEventBus_InvokeGainedAbility_System_String_System_Guid_System_Object_ + commentId: M:CSF.Screenplay.Performances.PerformanceEventBus.InvokeGainedAbility(System.String,System.Guid,System.Object) + name.vb: InvokeGainedAbility(String, Guid, Object) + fullName: CSF.Screenplay.Performances.PerformanceEventBus.InvokeGainedAbility(string, System.Guid, object) + fullName.vb: CSF.Screenplay.Performances.PerformanceEventBus.InvokeGainedAbility(String, System.Guid, Object) + nameWithType: PerformanceEventBus.InvokeGainedAbility(string, Guid, object) + nameWithType.vb: PerformanceEventBus.InvokeGainedAbility(String, Guid, Object) +- uid: CSF.Screenplay.Performances.PerformanceEventBus.InvokeGainedAbility* + name: InvokeGainedAbility + href: api/CSF.Screenplay.Performances.PerformanceEventBus.html#CSF_Screenplay_Performances_PerformanceEventBus_InvokeGainedAbility_ + commentId: Overload:CSF.Screenplay.Performances.PerformanceEventBus.InvokeGainedAbility + isSpec: "True" + fullName: CSF.Screenplay.Performances.PerformanceEventBus.InvokeGainedAbility + nameWithType: PerformanceEventBus.InvokeGainedAbility - uid: CSF.Screenplay.Performances.PerformanceEventBus.InvokePerformanceBegun(System.Guid,System.Collections.Generic.IList{CSF.Screenplay.Performances.IdentifierAndName}) name: InvokePerformanceBegun(Guid, IList) href: api/CSF.Screenplay.Performances.PerformanceEventBus.html#CSF_Screenplay_Performances_PerformanceEventBus_InvokePerformanceBegun_System_Guid_System_Collections_Generic_IList_CSF_Screenplay_Performances_IdentifierAndName__ @@ -3469,6 +3501,19 @@ references: isSpec: "True" fullName: CSF.Screenplay.ScreenplayPlugin.Initialize nameWithType: ScreenplayPlugin.Initialize +- uid: CSF.Screenplay.ScreenplayPlugin.Screenplay + name: Screenplay + href: api/CSF.Screenplay.ScreenplayPlugin.html#CSF_Screenplay_ScreenplayPlugin_Screenplay + commentId: P:CSF.Screenplay.ScreenplayPlugin.Screenplay + fullName: CSF.Screenplay.ScreenplayPlugin.Screenplay + nameWithType: ScreenplayPlugin.Screenplay +- uid: CSF.Screenplay.ScreenplayPlugin.Screenplay* + name: Screenplay + href: api/CSF.Screenplay.ScreenplayPlugin.html#CSF_Screenplay_ScreenplayPlugin_Screenplay_ + commentId: Overload:CSF.Screenplay.ScreenplayPlugin.Screenplay + isSpec: "True" + fullName: CSF.Screenplay.ScreenplayPlugin.Screenplay + nameWithType: ScreenplayPlugin.Screenplay - uid: CSF.Screenplay.ScreenplayServiceCollectionExtensions name: ScreenplayServiceCollectionExtensions href: api/CSF.Screenplay.ScreenplayServiceCollectionExtensions.html