This documentation is archived and is not being maintained.

TimerEventSubscription Class

Represents a subscription to a timer event.

System.Object
  System.Workflow.Runtime.TimerEventSubscription

Namespace:  System.Workflow.Runtime
Assembly:  System.Workflow.Runtime (in System.Workflow.Runtime.dll)

[SerializableAttribute]
public class TimerEventSubscription

The TimerEventSubscription type exposes the following members.

  NameDescription
Protected methodTimerEventSubscription()Initializes a new instance of the TimerEventSubscription class.
Public methodTimerEventSubscription(Guid, DateTime)Initializes a new instance of the TimerEventSubscription class by using the specified Guid of a workflow instance and the specified expiration DateTime.
Public methodTimerEventSubscription(Guid, Guid, DateTime)Initializes a new instance of the TimerEventSubscription class by using the specified subscription Id, the specified Guid of a workflow instance, and the specified expiration DateTime.
Top

  NameDescription
Public propertyExpiresAtGets the expected expiration time of the timer associated with this subscription.
Public propertyQueueNameRepresents the name of the WorkflowQueue that the WorkflowRuntime sends a message to when the timer subscription expires.
Public propertySubscriptionIdUnique identifier that represents a timer event
Public propertyWorkflowInstanceIdIdentifier of the workflow associated with the timer subscription
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

TimerEventSubscription objects are added to the timer queue associated with a workflow instance in order to send a message to a specific WorkflowQueue at a specified time. When the time specified by ExpiresAt is reached, the workflow runtime engine sends a message containing the SubscriptionId to the WorkflowQueue specified by QueueName. The timer queue associated with a workflow instance is contained in the TimerCollectionProperty. You can examine TimerCollectionProperty and the WorkflowQueueInfo objects returned by WorkflowInstance.GetWorkflowQueueData to determine which activities are waiting on a specific TimerEventSubscription. The DelayActivity and the SqlWorkflowPersistenceService both use timer event subscriptions to provide part of their functionality.

.NET Framework

Supported in: 4, 3.5, 3.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show: