-
Notifications
You must be signed in to change notification settings - Fork 255
/
IDurableEntityClient.xml
342 lines (342 loc) · 26.8 KB
/
IDurableEntityClient.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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
<Type Name="IDurableEntityClient" FullName="Microsoft.Azure.WebJobs.Extensions.DurableTask.IDurableEntityClient">
<TypeSignature Language="C#" Value="public interface IDurableEntityClient" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IDurableEntityClient" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.WebJobs.Extensions.DurableTask.IDurableEntityClient" />
<TypeSignature Language="VB.NET" Value="Public Interface IDurableEntityClient" />
<TypeSignature Language="F#" Value="type IDurableEntityClient = interface" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.DurableTask</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Docs>
<summary>
Provides functionality available to durable entity clients.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="CleanEntityStorageAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Azure.WebJobs.Extensions.DurableTask.CleanEntityStorageResult> CleanEntityStorageAsync (bool removeEmptyEntities, bool releaseOrphanedLocks, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<valuetype Microsoft.Azure.WebJobs.Extensions.DurableTask.CleanEntityStorageResult> CleanEntityStorageAsync(bool removeEmptyEntities, bool releaseOrphanedLocks, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.WebJobs.Extensions.DurableTask.IDurableEntityClient.CleanEntityStorageAsync(System.Boolean,System.Boolean,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function CleanEntityStorageAsync (removeEmptyEntities As Boolean, releaseOrphanedLocks As Boolean, cancellationToken As CancellationToken) As Task(Of CleanEntityStorageResult)" />
<MemberSignature Language="F#" Value="abstract member CleanEntityStorageAsync : bool * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.WebJobs.Extensions.DurableTask.CleanEntityStorageResult>" Usage="iDurableEntityClient.CleanEntityStorageAsync (removeEmptyEntities, releaseOrphanedLocks, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.DurableTask</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Azure.WebJobs.Extensions.DurableTask.CleanEntityStorageResult></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="removeEmptyEntities" Type="System.Boolean" />
<Parameter Name="releaseOrphanedLocks" Type="System.Boolean" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="removeEmptyEntities">Whether to remove empty entities.</param>
<param name="releaseOrphanedLocks">Whether to release orphaned locks.</param>
<param name="cancellationToken">Cancellation token that can be used to cancel the operation.</param>
<summary>
Removes empty entities from storage and releases orphaned locks.
</summary>
<returns>A task that completes when the operation is finished.</returns>
<remarks>An entity is considered empty, and is removed, if it has no state, is not locked, and has
been idle for more than <see cref="P:Microsoft.Azure.WebJobs.Extensions.DurableTask.DurableTaskOptions.EntityMessageReorderWindowInMinutes" /> minutes.
Locks are considered orphaned, and are released, if the orchestration that holds them is not in state <see cref="F:Microsoft.Azure.WebJobs.Extensions.DurableTask.OrchestrationRuntimeStatus.Running" />. This
should not happen under normal circumstances, but can occur if the orchestration instance holding the lock
exhibits replay nondeterminism failures, or if it is explicitly purged.</remarks>
</Docs>
</Member>
<Member MemberName="ListEntitiesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityQueryResult> ListEntitiesAsync (Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityQuery query, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityQueryResult> ListEntitiesAsync(class Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityQuery query, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.WebJobs.Extensions.DurableTask.IDurableEntityClient.ListEntitiesAsync(Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityQuery,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function ListEntitiesAsync (query As EntityQuery, cancellationToken As CancellationToken) As Task(Of EntityQueryResult)" />
<MemberSignature Language="F#" Value="abstract member ListEntitiesAsync : Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityQuery * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityQueryResult>" Usage="iDurableEntityClient.ListEntitiesAsync (query, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.DurableTask</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityQueryResult></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="query" Type="Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityQuery" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="query">Return entity instances that match the specified query conditions.</param>
<param name="cancellationToken">Cancellation token that can be used to cancel the query operation.</param>
<summary>
Gets the status of all entity instances with paging that match the specified query conditions.
</summary>
<returns>Returns a page of entity instances and a continuation token for fetching the next page.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ReadEntityStateAsync<T>">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityStateResponse<T>> ReadEntityStateAsync<T> (Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityId entityId, string taskHubName = default, string connectionName = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<valuetype Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityStateResponse`1<!!T>> ReadEntityStateAsync<T>(valuetype Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityId entityId, string taskHubName, string connectionName) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.WebJobs.Extensions.DurableTask.IDurableEntityClient.ReadEntityStateAsync``1(Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityId,System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function ReadEntityStateAsync(Of T) (entityId As EntityId, Optional taskHubName As String = Nothing, Optional connectionName As String = Nothing) As Task(Of EntityStateResponse(Of T))" />
<MemberSignature Language="F#" Value="abstract member ReadEntityStateAsync : Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityId * string * string -> System.Threading.Tasks.Task<Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityStateResponse<'T>>" Usage="iDurableEntityClient.ReadEntityStateAsync (entityId, taskHubName, connectionName)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.DurableTask</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityStateResponse<T>></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="entityId" Type="Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityId" />
<Parameter Name="taskHubName" Type="System.String" />
<Parameter Name="connectionName" Type="System.String" />
</Parameters>
<Docs>
<typeparam name="T">The JSON-serializable type of the entity.</typeparam>
<param name="entityId">The target entity.</param>
<param name="taskHubName">The TaskHubName of the target entity.</param>
<param name="connectionName">The name of the connection string associated with <paramref name="taskHubName" />.</param>
<summary>
Tries to read the current state of an entity. Returns default(<typeparamref name="T" />) if the entity does not exist.
</summary>
<returns>a response containing the current state of the entity.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SignalEntityAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task SignalEntityAsync (Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityId entityId, string operationName, object operationInput = default, string taskHubName = default, string connectionName = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task SignalEntityAsync(valuetype Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityId entityId, string operationName, object operationInput, string taskHubName, string connectionName) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.WebJobs.Extensions.DurableTask.IDurableEntityClient.SignalEntityAsync(Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityId,System.String,System.Object,System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function SignalEntityAsync (entityId As EntityId, operationName As String, Optional operationInput As Object = Nothing, Optional taskHubName As String = Nothing, Optional connectionName As String = Nothing) As Task" />
<MemberSignature Language="F#" Value="abstract member SignalEntityAsync : Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityId * string * obj * string * string -> System.Threading.Tasks.Task" Usage="iDurableEntityClient.SignalEntityAsync (entityId, operationName, operationInput, taskHubName, connectionName)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.DurableTask</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="entityId" Type="Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityId" />
<Parameter Name="operationName" Type="System.String" />
<Parameter Name="operationInput" Type="System.Object" />
<Parameter Name="taskHubName" Type="System.String" />
<Parameter Name="connectionName" Type="System.String" />
</Parameters>
<Docs>
<param name="entityId">The target entity.</param>
<param name="operationName">The name of the operation.</param>
<param name="operationInput">The input for the operation.</param>
<param name="taskHubName">The TaskHubName of the target entity.</param>
<param name="connectionName">The name of the connection string associated with <paramref name="taskHubName" />.</param>
<summary>
Signals an entity to perform an operation.
</summary>
<returns>A task that completes when the message has been reliably enqueued.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SignalEntityAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task SignalEntityAsync (Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityId entityId, DateTime scheduledTimeUtc, string operationName, object operationInput = default, string taskHubName = default, string connectionName = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task SignalEntityAsync(valuetype Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityId entityId, valuetype System.DateTime scheduledTimeUtc, string operationName, object operationInput, string taskHubName, string connectionName) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.WebJobs.Extensions.DurableTask.IDurableEntityClient.SignalEntityAsync(Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityId,System.DateTime,System.String,System.Object,System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function SignalEntityAsync (entityId As EntityId, scheduledTimeUtc As DateTime, operationName As String, Optional operationInput As Object = Nothing, Optional taskHubName As String = Nothing, Optional connectionName As String = Nothing) As Task" />
<MemberSignature Language="F#" Value="abstract member SignalEntityAsync : Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityId * DateTime * string * obj * string * string -> System.Threading.Tasks.Task" Usage="iDurableEntityClient.SignalEntityAsync (entityId, scheduledTimeUtc, operationName, operationInput, taskHubName, connectionName)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.DurableTask</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="entityId" Type="Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityId" />
<Parameter Name="scheduledTimeUtc" Type="System.DateTime" />
<Parameter Name="operationName" Type="System.String" />
<Parameter Name="operationInput" Type="System.Object" />
<Parameter Name="taskHubName" Type="System.String" />
<Parameter Name="connectionName" Type="System.String" />
</Parameters>
<Docs>
<param name="entityId">The target entity.</param>
<param name="scheduledTimeUtc">The time at which to start the operation.</param>
<param name="operationName">The name of the operation.</param>
<param name="operationInput">The input for the operation.</param>
<param name="taskHubName">The TaskHubName of the target entity.</param>
<param name="connectionName">The name of the connection string associated with <paramref name="taskHubName" />.</param>
<summary>
Signals an entity to perform an operation, at a specified time.
</summary>
<returns>A task that completes when the message has been reliably enqueued.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SignalEntityAsync<TEntityInterface>">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task SignalEntityAsync<TEntityInterface> (Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityId entityId, Action<TEntityInterface> operation);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task SignalEntityAsync<TEntityInterface>(valuetype Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityId entityId, class System.Action`1<!!TEntityInterface> operation) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.WebJobs.Extensions.DurableTask.IDurableEntityClient.SignalEntityAsync``1(Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityId,System.Action{``0})" />
<MemberSignature Language="VB.NET" Value="Public Function SignalEntityAsync(Of TEntityInterface) (entityId As EntityId, operation As Action(Of TEntityInterface)) As Task" />
<MemberSignature Language="F#" Value="abstract member SignalEntityAsync : Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityId * Action<'EntityInterface> -> System.Threading.Tasks.Task" Usage="iDurableEntityClient.SignalEntityAsync (entityId, operation)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.DurableTask</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TEntityInterface" />
</TypeParameters>
<Parameters>
<Parameter Name="entityId" Type="Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityId" />
<Parameter Name="operation" Type="System.Action<TEntityInterface>" />
</Parameters>
<Docs>
<typeparam name="TEntityInterface">Entity interface.</typeparam>
<param name="entityId">The target entity.</param>
<param name="operation">A delegate that performs the desired operation on the entity.</param>
<summary>
Signals an entity to perform an operation.
</summary>
<returns>A task that completes when the message has been reliably enqueued.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SignalEntityAsync<TEntityInterface>">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task SignalEntityAsync<TEntityInterface> (string entityKey, Action<TEntityInterface> operation);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task SignalEntityAsync<TEntityInterface>(string entityKey, class System.Action`1<!!TEntityInterface> operation) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.WebJobs.Extensions.DurableTask.IDurableEntityClient.SignalEntityAsync``1(System.String,System.Action{``0})" />
<MemberSignature Language="VB.NET" Value="Public Function SignalEntityAsync(Of TEntityInterface) (entityKey As String, operation As Action(Of TEntityInterface)) As Task" />
<MemberSignature Language="F#" Value="abstract member SignalEntityAsync : string * Action<'EntityInterface> -> System.Threading.Tasks.Task" Usage="iDurableEntityClient.SignalEntityAsync (entityKey, operation)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.DurableTask</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TEntityInterface" />
</TypeParameters>
<Parameters>
<Parameter Name="entityKey" Type="System.String" />
<Parameter Name="operation" Type="System.Action<TEntityInterface>" />
</Parameters>
<Docs>
<typeparam name="TEntityInterface">Entity interface.</typeparam>
<param name="entityKey">The target entity key.</param>
<param name="operation">A delegate that performs the desired operation on the entity.</param>
<summary>
Signals an entity to perform an operation.
</summary>
<returns>A task that completes when the message has been reliably enqueued.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SignalEntityAsync<TEntityInterface>">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task SignalEntityAsync<TEntityInterface> (Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityId entityId, DateTime scheduledTimeUtc, Action<TEntityInterface> operation);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task SignalEntityAsync<TEntityInterface>(valuetype Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityId entityId, valuetype System.DateTime scheduledTimeUtc, class System.Action`1<!!TEntityInterface> operation) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.WebJobs.Extensions.DurableTask.IDurableEntityClient.SignalEntityAsync``1(Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityId,System.DateTime,System.Action{``0})" />
<MemberSignature Language="VB.NET" Value="Public Function SignalEntityAsync(Of TEntityInterface) (entityId As EntityId, scheduledTimeUtc As DateTime, operation As Action(Of TEntityInterface)) As Task" />
<MemberSignature Language="F#" Value="abstract member SignalEntityAsync : Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityId * DateTime * Action<'EntityInterface> -> System.Threading.Tasks.Task" Usage="iDurableEntityClient.SignalEntityAsync (entityId, scheduledTimeUtc, operation)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.DurableTask</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TEntityInterface" />
</TypeParameters>
<Parameters>
<Parameter Name="entityId" Type="Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityId" />
<Parameter Name="scheduledTimeUtc" Type="System.DateTime" />
<Parameter Name="operation" Type="System.Action<TEntityInterface>" />
</Parameters>
<Docs>
<typeparam name="TEntityInterface">Entity interface.</typeparam>
<param name="entityId">The target entity.</param>
<param name="scheduledTimeUtc">The time at which to start the operation.</param>
<param name="operation">A delegate that performs the desired operation on the entity.</param>
<summary>
Signals an entity to perform an operation, at a specified time.
</summary>
<returns>A task that completes when the message has been reliably enqueued.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SignalEntityAsync<TEntityInterface>">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task SignalEntityAsync<TEntityInterface> (string entityKey, DateTime scheduledTimeUtc, Action<TEntityInterface> operation);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task SignalEntityAsync<TEntityInterface>(string entityKey, valuetype System.DateTime scheduledTimeUtc, class System.Action`1<!!TEntityInterface> operation) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.WebJobs.Extensions.DurableTask.IDurableEntityClient.SignalEntityAsync``1(System.String,System.DateTime,System.Action{``0})" />
<MemberSignature Language="VB.NET" Value="Public Function SignalEntityAsync(Of TEntityInterface) (entityKey As String, scheduledTimeUtc As DateTime, operation As Action(Of TEntityInterface)) As Task" />
<MemberSignature Language="F#" Value="abstract member SignalEntityAsync : string * DateTime * Action<'EntityInterface> -> System.Threading.Tasks.Task" Usage="iDurableEntityClient.SignalEntityAsync (entityKey, scheduledTimeUtc, operation)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.DurableTask</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TEntityInterface" />
</TypeParameters>
<Parameters>
<Parameter Name="entityKey" Type="System.String" />
<Parameter Name="scheduledTimeUtc" Type="System.DateTime" />
<Parameter Name="operation" Type="System.Action<TEntityInterface>" />
</Parameters>
<Docs>
<typeparam name="TEntityInterface">Entity interface.</typeparam>
<param name="entityKey">The target entity key.</param>
<param name="scheduledTimeUtc">The time at which to start the operation.</param>
<param name="operation">A delegate that performs the desired operation on the entity.</param>
<summary>
Signals an entity to perform an operation, at a specified time.
</summary>
<returns>A task that completes when the message has been reliably enqueued.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TaskHubName">
<MemberSignature Language="C#" Value="public string TaskHubName { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string TaskHubName" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.Extensions.DurableTask.IDurableEntityClient.TaskHubName" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property TaskHubName As String" />
<MemberSignature Language="F#" Value="member this.TaskHubName : string" Usage="Microsoft.Azure.WebJobs.Extensions.DurableTask.IDurableEntityClient.TaskHubName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.DurableTask</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the name of the task hub configured on this client instance.
</summary>
<value>
The name of the task hub.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>