Class CompositeEventBase<T>
Compostite base class for all event related activities. The composite base class is responsible for event registration/unregistration to hosts EventTrackingService.
Inheritance
Implements
Namespace: EPiServer.WorkflowFoundation.Activities
Assembly: EPiServer.WorkflowFoundation.dll
Version: 8.11.0Syntax
public abstract class CompositeEventBase<T> : SequenceActivity, IEventActivity where T : HandleExternalEventActivity, new()
Type Parameters
Name | Description |
---|---|
T | the "raw" event activity |
Constructors
CompositeEventBase()
Initializes a new instance of the CompositeEventBase<T> class.
Declaration
protected CompositeEventBase()
Properties
Description
Gets or sets the user defined description of the System.
Declaration
public string Description { get; set; }
Property Value
Type | Description |
---|---|
System. |
EventActivity
Gets wrapped "raw" event activity.
Declaration
protected T EventActivity { get; }
Property Value
Type | Description |
---|---|
T | The event activity. |
QueueName
Gets the name of the System.
Declaration
public IComparable QueueName { get; }
Property Value
Type | Description |
---|---|
System. |
Methods
OnEventRegistered(Guid, String)
Raises the Event
Declaration
protected void OnEventRegistered(Guid instanceId, string eventName)
Parameters
Type | Name | Description |
---|---|---|
System. |
instanceId | The instance id. |
System. |
eventName | Name of the event. |
RegisterEvent(Object, EventArgs)
Register event with EventTrackingService so host knows that this instance waits for event
Declaration
protected virtual void RegisterEvent(object sender, EventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System. |
sender | The sender. |
System. |
e | The System. |
Subscribe(ActivityExecutionContext, IActivityEventListener<QueueEventArgs>)
Creates the subscription of an Microsoft.
Declaration
public void Subscribe(ActivityExecutionContext parentContext, IActivityEventListener<QueueEventArgs> parentEventHandler)
Parameters
Type | Name | Description |
---|---|---|
System. |
parentContext | The System. |
System. |
parentEventHandler | The System. |
UnregisterEvent(Object, EventArgs)
Unregister event with EventTrackingService
Declaration
protected virtual void UnregisterEvent(object sender, EventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System. |
sender | The sender. |
System. |
e | The System. |
Unsubscribe(ActivityExecutionContext, IActivityEventListener<QueueEventArgs>)
Cancels the subscription of an Microsoft.
Declaration
public void Unsubscribe(ActivityExecutionContext parentContext, IActivityEventListener<QueueEventArgs> parentEventHandler)
Parameters
Type | Name | Description |
---|---|---|
System. |
parentContext | The System. |
System. |
parentEventHandler | The System. |
Events
EventRegistered
Occurs when an event is registered.
Declaration
public event EventHandler<EventRegisterEventArgs> EventRegistered
Event Type
Type | Description |
---|---|
System. |