/
TimerEventSubscription.xml
243 lines (231 loc) · 16.8 KB
/
TimerEventSubscription.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
<Type Name="TimerEventSubscription" FullName="System.Workflow.Runtime.TimerEventSubscription">
<TypeSignature Language="C#" Value="public class TimerEventSubscription" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi serializable beforefieldinit TimerEventSubscription extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.Workflow.Runtime.TimerEventSubscription" />
<TypeSignature Language="VB.NET" Value="Public Class TimerEventSubscription" />
<TypeSignature Language="F#" Value="type TimerEventSubscription = class" />
<TypeSignature Language="C++ CLI" Value="public ref class TimerEventSubscription" />
<AssemblyInfo>
<AssemblyName>System.Workflow.Runtime</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Serializable]</AttributeName>
<AttributeName Language="F#">[<System.Serializable>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1">
<AttributeName Language="C#">[System.Obsolete("The System.Workflow.* types are deprecated. Instead, please use the new types from System.Activities.*")]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("The System.Workflow.* types are deprecated. Instead, please use the new types from System.Activities.*")>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Represents a subscription to a timer event.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
> [!NOTE]
> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)]
<xref:System.Workflow.Runtime.TimerEventSubscription> objects are added to the timer queue associated with a workflow instance in order to send a message to a specific <xref:System.Workflow.Runtime.WorkflowQueue> at a specified time. When the time specified by <xref:System.Workflow.Runtime.TimerEventSubscription.ExpiresAt%2A> is reached, the workflow runtime engine sends a message containing the <xref:System.Workflow.Runtime.TimerEventSubscription.SubscriptionId%2A> to the <xref:System.Workflow.Runtime.WorkflowQueue> specified by <xref:System.Workflow.Runtime.TimerEventSubscription.QueueName%2A>. The timer queue associated with a workflow instance is contained in the <xref:System.Workflow.Runtime.TimerEventSubscriptionCollection.TimerCollectionProperty>. You can examine <xref:System.Workflow.Runtime.TimerEventSubscriptionCollection.TimerCollectionProperty> and the <xref:System.Workflow.Runtime.WorkflowQueueInfo> objects returned by <xref:System.Workflow.Runtime.WorkflowInstance.GetWorkflowQueueData%2A?displayProperty=nameWithType> to determine which activities are waiting on a specific <xref:System.Workflow.Runtime.TimerEventSubscription>. The <xref:System.Workflow.Activities.DelayActivity> and the <xref:System.Workflow.Runtime.Hosting.SqlWorkflowPersistenceService> both use timer event subscriptions to provide part of their functionality.
]]></format>
</remarks>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<AssemblyInfo>
<AssemblyName>System.Workflow.Runtime</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Workflow.Runtime.TimerEventSubscription" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected TimerEventSubscription ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Workflow.Runtime.TimerEventSubscription.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberSignature Language="C++ CLI" Value="protected:
 TimerEventSubscription();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.Runtime</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Workflow.Runtime.TimerEventSubscription" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TimerEventSubscription (Guid workflowInstanceId, DateTime expiresAt);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.Guid workflowInstanceId, valuetype System.DateTime expiresAt) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Workflow.Runtime.TimerEventSubscription.#ctor(System.Guid,System.DateTime)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (workflowInstanceId As Guid, expiresAt As DateTime)" />
<MemberSignature Language="F#" Value="new System.Workflow.Runtime.TimerEventSubscription : Guid * DateTime -> System.Workflow.Runtime.TimerEventSubscription" Usage="new System.Workflow.Runtime.TimerEventSubscription (workflowInstanceId, expiresAt)" />
<MemberSignature Language="C++ CLI" Value="public:
 TimerEventSubscription(Guid workflowInstanceId, DateTime expiresAt);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.Runtime</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="workflowInstanceId" Type="System.Guid" />
<Parameter Name="expiresAt" Type="System.DateTime" />
</Parameters>
<Docs>
<param name="workflowInstanceId">The <see cref="T:System.Guid" /> of the workflow instance associated with this subscription.</param>
<param name="expiresAt">A <see cref="T:System.DateTime" /> that represents the time in Universal Coordinated Time (UTC) at which the timer associated with this subscription is expected to expire.</param>
<summary>Initializes a new instance of the <see cref="T:System.Workflow.Runtime.TimerEventSubscription" /> class by using the specified <see cref="T:System.Guid" /> of a workflow instance and the specified expiration <see cref="T:System.DateTime" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The following table shows the initial property values for an instance of <xref:System.Workflow.Runtime.TimerEventSubscription>.
|Property|Value|
|--------------|-----------|
|<xref:System.Workflow.Runtime.TimerEventSubscription.QueueName%2A>|A string representation of the system-supplied <xref:System.Guid> for <xref:System.Workflow.Runtime.TimerEventSubscription.SubscriptionId%2A>.|
|<xref:System.Workflow.Runtime.TimerEventSubscription.SubscriptionId%2A>|A system-supplied <xref:System.Guid>.|
|<xref:System.Workflow.Runtime.TimerEventSubscription.WorkflowInstanceId%2A>|The <xref:System.Guid> of the workflow instance, specified by `workflowInstanceId`.|
|<xref:System.Workflow.Runtime.TimerEventSubscription.ExpiresAt%2A>|The <xref:System.DateTime> specified by `expiresAt`.|
<xref:System.Workflow.Runtime.TimerEventSubscription.QueueName%2A> is initialized to a string representation of <xref:System.Workflow.Runtime.TimerEventSubscription.SubscriptionId%2A> by this constructor.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TimerEventSubscription (Guid timerId, Guid workflowInstanceId, DateTime expiresAt);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.Guid timerId, valuetype System.Guid workflowInstanceId, valuetype System.DateTime expiresAt) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Workflow.Runtime.TimerEventSubscription.#ctor(System.Guid,System.Guid,System.DateTime)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (timerId As Guid, workflowInstanceId As Guid, expiresAt As DateTime)" />
<MemberSignature Language="F#" Value="new System.Workflow.Runtime.TimerEventSubscription : Guid * Guid * DateTime -> System.Workflow.Runtime.TimerEventSubscription" Usage="new System.Workflow.Runtime.TimerEventSubscription (timerId, workflowInstanceId, expiresAt)" />
<MemberSignature Language="C++ CLI" Value="public:
 TimerEventSubscription(Guid timerId, Guid workflowInstanceId, DateTime expiresAt);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.Runtime</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="timerId" Type="System.Guid" />
<Parameter Name="workflowInstanceId" Type="System.Guid" />
<Parameter Name="expiresAt" Type="System.DateTime" />
</Parameters>
<Docs>
<param name="timerId">The <see cref="T:System.Guid" /> for this subscription.</param>
<param name="workflowInstanceId">The <see cref="T:System.Guid" /> of the workflow instance for which this subscription was created.</param>
<param name="expiresAt">A <see cref="T:System.DateTime" /> that represents the time in Universal Coordinated Time (UTC) at which the timer for this subscription is expected to expire.</param>
<summary>Initializes a new instance of the <see cref="T:System.Workflow.Runtime.TimerEventSubscription" /> class by using the specified subscription Id, the specified <see cref="T:System.Guid" /> of a workflow instance, and the specified expiration <see cref="T:System.DateTime" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The following table shows the initial property values for an instance of <xref:System.Workflow.Runtime.TimerEventSubscription>.
|Property|Value|
|--------------|-----------|
|<xref:System.Workflow.Runtime.TimerEventSubscription.QueueName%2A>|A string representation of the <xref:System.Guid> specified by `timerId`.|
|<xref:System.Workflow.Runtime.TimerEventSubscription.SubscriptionId%2A>|The <xref:System.Guid> specified by `timerId`.|
|<xref:System.Workflow.Runtime.TimerEventSubscription.WorkflowInstanceId%2A>|The <xref:System.Guid> of the workflow instance, specified by `workflowInstanceId`.|
|<xref:System.Workflow.Runtime.TimerEventSubscription.ExpiresAt%2A>|The <xref:System.DateTime> specified by `expiresAt`.|
<xref:System.Workflow.Runtime.TimerEventSubscription.QueueName%2A> is initialized to a string representation of `timerId` by this constructor.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ExpiresAt">
<MemberSignature Language="C#" Value="public virtual DateTime ExpiresAt { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTime ExpiresAt" />
<MemberSignature Language="DocId" Value="P:System.Workflow.Runtime.TimerEventSubscription.ExpiresAt" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property ExpiresAt As DateTime" />
<MemberSignature Language="F#" Value="member this.ExpiresAt : DateTime" Usage="System.Workflow.Runtime.TimerEventSubscription.ExpiresAt" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property DateTime ExpiresAt { DateTime get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.Runtime</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.DateTime</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the expected expiration time of the timer associated with this subscription.</summary>
<value>A <see cref="T:System.DateTime" /> that represents the time in Universal Coordinated Time (UTC) at which the timer associated with this subscription is expected to expire.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="QueueName">
<MemberSignature Language="C#" Value="public virtual IComparable QueueName { get; protected set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.IComparable QueueName" />
<MemberSignature Language="DocId" Value="P:System.Workflow.Runtime.TimerEventSubscription.QueueName" />
<MemberSignature Language="VB.NET" Value="Public Overridable Property QueueName As IComparable" />
<MemberSignature Language="F#" Value="member this.QueueName : IComparable with get, set" Usage="System.Workflow.Runtime.TimerEventSubscription.QueueName" />
<MemberSignature Language="C++ CLI" Value="public: virtual property IComparable ^ QueueName { public:
IComparable ^ get(); protected:
 void set(IComparable ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.Runtime</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IComparable</ReturnType>
</ReturnValue>
<Docs>
<summary>Represents the name of the <see cref="T:System.Workflow.Runtime.WorkflowQueue" /> that the <see cref="T:System.Workflow.Runtime.WorkflowRuntime" /> sends a message to when the timer subscription expires.</summary>
<value>The <see cref="T:System.IComparable" /> interface for a <see cref="T:System.Guid" /> object.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SubscriptionId">
<MemberSignature Language="C#" Value="public virtual Guid SubscriptionId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Guid SubscriptionId" />
<MemberSignature Language="DocId" Value="P:System.Workflow.Runtime.TimerEventSubscription.SubscriptionId" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property SubscriptionId As Guid" />
<MemberSignature Language="F#" Value="member this.SubscriptionId : Guid" Usage="System.Workflow.Runtime.TimerEventSubscription.SubscriptionId" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property Guid SubscriptionId { Guid get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.Runtime</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Guid</ReturnType>
</ReturnValue>
<Docs>
<summary>Unique identifier that represents a timer event.</summary>
<value>
<see cref="T:System.Guid" /> representing the unique identifier for a timer event.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WorkflowInstanceId">
<MemberSignature Language="C#" Value="public virtual Guid WorkflowInstanceId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Guid WorkflowInstanceId" />
<MemberSignature Language="DocId" Value="P:System.Workflow.Runtime.TimerEventSubscription.WorkflowInstanceId" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property WorkflowInstanceId As Guid" />
<MemberSignature Language="F#" Value="member this.WorkflowInstanceId : Guid" Usage="System.Workflow.Runtime.TimerEventSubscription.WorkflowInstanceId" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property Guid WorkflowInstanceId { Guid get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.Runtime</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Guid</ReturnType>
</ReturnValue>
<Docs>
<summary>Identifier of the workflow associated with the timer subscription.</summary>
<value>
<see cref="T:System.Guid" /> representing the unique identifier for the workflow associated with the timer subscription.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>