TimerEventSubscription Class

Reference

Definition

Namespace:: System.Workflow.Runtime

Assembly:: System.Workflow.Runtime.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Caution

The System.Workflow.* types are deprecated. Instead, please use the new types from System.Activities.*

Represents a subscription to a timer event.

public ref class TimerEventSubscription

[System.Serializable]
public class TimerEventSubscription

[System.Serializable]
[System.Obsolete("The System.Workflow.* types are deprecated.  Instead, please use the new types from System.Activities.*")]
public class TimerEventSubscription

[<System.Serializable>]
type TimerEventSubscription = class

[<System.Serializable>]
[<System.Obsolete("The System.Workflow.* types are deprecated.  Instead, please use the new types from System.Activities.*")>]
type TimerEventSubscription = class

Public Class TimerEventSubscription

Inheritance: Object
TimerEventSubscription

Attributes: SerializableAttribute ObsoleteAttribute

Remarks

Note

This material discusses types and namespaces that are obsolete. For more information, see Deprecated Types in Windows Workflow Foundation 4.5.

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.

Constructors

TimerEventSubscription()	Initializes a new instance of the TimerEventSubscription class.
TimerEventSubscription(Guid, DateTime)	Initializes a new instance of the TimerEventSubscription class by using the specified Guid of a workflow instance and the specified expiration DateTime.
TimerEventSubscription(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.

Properties

ExpiresAt	Gets the expected expiration time of the timer associated with this subscription.
QueueName	Represents the name of the WorkflowQueue that the WorkflowRuntime sends a message to when the timer subscription expires.
SubscriptionId	Unique identifier that represents a timer event.
WorkflowInstanceId	Identifier of the workflow associated with the timer subscription.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Applies to