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: 7.19.2Syntax
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.Workflow.ComponentModel.Activity.
Declaration
public string Description { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
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.Workflow.Runtime.WorkflowQueue on which the activity is waiting for data to arrive.
Declaration
public IComparable QueueName { get; }Property Value
| Type | Description |
|---|---|
| System.IComparable |
Methods
OnEventRegistered(Guid, String)
Raises the EventRegistered event.
Declaration
protected void OnEventRegistered(Guid instanceId, string eventName)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | instanceId | The instance id. |
| System.String | 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.Object | sender | The sender. |
| System.EventArgs | e | The System.EventArgs instance containing the event data. |
Subscribe(ActivityExecutionContext, IActivityEventListener<QueueEventArgs>)
Creates the subscription of an Microsoft.Workflow.ComponentModel.Activity to an event.
Declaration
public void Subscribe(ActivityExecutionContext parentContext, IActivityEventListener<QueueEventArgs> parentEventHandler)Parameters
| Type | Name | Description |
|---|---|---|
| System.Workflow.ComponentModel.ActivityExecutionContext | parentContext | The System.Workflow.ComponentModel.ActivityExecutionContext that represents the execution environment of the System.Workflow.ComponentModel.Activity. |
| System.Workflow.ComponentModel.IActivityEventListener<System.Workflow.ComponentModel.QueueEventArgs> | parentEventHandler | The System.EventHandler for the parent event. |
UnregisterEvent(Object, EventArgs)
Unregister event with EventTrackingService
Declaration
protected virtual void UnregisterEvent(object sender, EventArgs e)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | sender | The sender. |
| System.EventArgs | e | The System.EventArgs instance containing the event data. |
Unsubscribe(ActivityExecutionContext, IActivityEventListener<QueueEventArgs>)
Cancels the subscription of an Microsoft.Workflow.ComponentModel.Activity to an event.
Declaration
public void Unsubscribe(ActivityExecutionContext parentContext, IActivityEventListener<QueueEventArgs> parentEventHandler)Parameters
| Type | Name | Description |
|---|---|---|
| System.Workflow.ComponentModel.ActivityExecutionContext | parentContext | The System.Workflow.ComponentModel.ActivityExecutionContext that represents the execution environment of the System.Workflow.ComponentModel.Activity. |
| System.Workflow.ComponentModel.IActivityEventListener<System.Workflow.ComponentModel.QueueEventArgs> | parentEventHandler | The System.EventHandler for the parent event. |
Events
EventRegistered
Occurs when an event is registered.
Declaration
public event EventHandler<EventRegisterEventArgs> EventRegisteredEvent Type
| Type | Description |
|---|---|
| System.EventHandler<EventRegisterEventArgs> |
