-
Notifications
You must be signed in to change notification settings - Fork 256
/
IActorStateProvider.xml
491 lines (491 loc) · 40.9 KB
/
IActorStateProvider.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
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
<Type Name="IActorStateProvider" FullName="Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider">
<TypeSignature Language="C#" Value="public interface IActorStateProvider : Microsoft.ServiceFabric.Data.IStateProviderReplica2" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IActorStateProvider implements class Microsoft.ServiceFabric.Data.IStateProviderReplica, class Microsoft.ServiceFabric.Data.IStateProviderReplica2" />
<TypeSignature Language="DocId" Value="T:Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider" />
<TypeSignature Language="VB.NET" Value="Public Interface IActorStateProvider
Implements IStateProviderReplica2" />
<TypeSignature Language="F#" Value="type IActorStateProvider = interface
 interface IStateProviderReplica2
 interface IStateProviderReplica" />
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.ServiceFabric.Data.IStateProviderReplica</InterfaceName>
</Interface>
<Interface>
<InterfaceName>Microsoft.ServiceFabric.Data.IStateProviderReplica2</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
Represents the interface that an actor state provider needs to implement for
actor runtime to communicate with it.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="ActorActivatedAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task ActorActivatedAsync (Microsoft.ServiceFabric.Actors.ActorId actorId, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task ActorActivatedAsync(class Microsoft.ServiceFabric.Actors.ActorId actorId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.ActorActivatedAsync(Microsoft.ServiceFabric.Actors.ActorId,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function ActorActivatedAsync (actorId As ActorId, Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="abstract member ActorActivatedAsync : Microsoft.ServiceFabric.Actors.ActorId * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="iActorStateProvider.ActorActivatedAsync (actorId, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="actorId" Type="Microsoft.ServiceFabric.Actors.ActorId" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="actorId">ID of the actor that is activated.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<summary>
Invoked as part of the activation process of the actor with the specified actor ID.
</summary>
<returns>A task that represents the asynchronous actor activation notification processing.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.OperationCanceledException">The operation was canceled.</exception>
</Docs>
</Member>
<Member MemberName="ContainsStateAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<bool> ContainsStateAsync (Microsoft.ServiceFabric.Actors.ActorId actorId, string stateName, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<bool> ContainsStateAsync(class Microsoft.ServiceFabric.Actors.ActorId actorId, string stateName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.ContainsStateAsync(Microsoft.ServiceFabric.Actors.ActorId,System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function ContainsStateAsync (actorId As ActorId, stateName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Boolean)" />
<MemberSignature Language="F#" Value="abstract member ContainsStateAsync : Microsoft.ServiceFabric.Actors.ActorId * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>" Usage="iActorStateProvider.ContainsStateAsync (actorId, stateName, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.Boolean></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="actorId" Type="Microsoft.ServiceFabric.Actors.ActorId" />
<Parameter Name="stateName" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="actorId">ID of the actor for which to check state existence.</param>
<param name="stateName">Name of the actor state to check for existence.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<summary>
Checks whether actor state provider contains an actor state with
specified state name for the specified actor ID.
</summary>
<returns>
A task that represents the asynchronous check operation. The value of TResult
parameter is <c>true</c> if state with specified name exists otherwise <c>false</c>.
</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.OperationCanceledException">The operation was canceled.</exception>
</Docs>
</Member>
<Member MemberName="DeleteReminderAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task DeleteReminderAsync (Microsoft.ServiceFabric.Actors.ActorId actorId, string reminderName, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task DeleteReminderAsync(class Microsoft.ServiceFabric.Actors.ActorId actorId, string reminderName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.DeleteReminderAsync(Microsoft.ServiceFabric.Actors.ActorId,System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function DeleteReminderAsync (actorId As ActorId, reminderName As String, Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="abstract member DeleteReminderAsync : Microsoft.ServiceFabric.Actors.ActorId * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="iActorStateProvider.DeleteReminderAsync (actorId, reminderName, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="actorId" Type="Microsoft.ServiceFabric.Actors.ActorId" />
<Parameter Name="reminderName" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="actorId">ID of the actor for which to delete the reminder.</param>
<param name="reminderName">Name of the reminder to delete.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<summary>
Deletes the actor reminder with the given reminder name if it exists
</summary>
<returns>A task that represents the asynchronous delete operation.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.OperationCanceledException">The operation was canceled.</exception>
</Docs>
</Member>
<Member MemberName="DeleteRemindersAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task DeleteRemindersAsync (System.Collections.Generic.IReadOnlyDictionary<Microsoft.ServiceFabric.Actors.ActorId,System.Collections.Generic.IReadOnlyCollection<string>> reminderNames, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task DeleteRemindersAsync(class System.Collections.Generic.IReadOnlyDictionary`2<class Microsoft.ServiceFabric.Actors.ActorId, class System.Collections.Generic.IReadOnlyCollection`1<string>> reminderNames, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.DeleteRemindersAsync(System.Collections.Generic.IReadOnlyDictionary{Microsoft.ServiceFabric.Actors.ActorId,System.Collections.Generic.IReadOnlyCollection{System.String}},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function DeleteRemindersAsync (reminderNames As IReadOnlyDictionary(Of ActorId, IReadOnlyCollection(Of String)), Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="abstract member DeleteRemindersAsync : System.Collections.Generic.IReadOnlyDictionary<Microsoft.ServiceFabric.Actors.ActorId, System.Collections.Generic.IReadOnlyCollection<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="iActorStateProvider.DeleteRemindersAsync (reminderNames, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="reminderNames" Type="System.Collections.Generic.IReadOnlyDictionary<Microsoft.ServiceFabric.Actors.ActorId,System.Collections.Generic.IReadOnlyCollection<System.String>>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="reminderNames">The set of reminders to delete.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<summary>
Deletes the specified set of reminders.
</summary>
<returns>A task that represents the asynchronous delete operation.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.OperationCanceledException">The operation was canceled.</exception>
</Docs>
</Member>
<Member MemberName="EnumerateStateNamesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<string>> EnumerateStateNamesAsync (Microsoft.ServiceFabric.Actors.ActorId actorId, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class System.Collections.Generic.IEnumerable`1<string>> EnumerateStateNamesAsync(class Microsoft.ServiceFabric.Actors.ActorId actorId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.EnumerateStateNamesAsync(Microsoft.ServiceFabric.Actors.ActorId,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function EnumerateStateNamesAsync (actorId As ActorId, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IEnumerable(Of String))" />
<MemberSignature Language="F#" Value="abstract member EnumerateStateNamesAsync : Microsoft.ServiceFabric.Actors.ActorId * System.Threading.CancellationToken -> System.Threading.Tasks.Task<seq<string>>" Usage="iActorStateProvider.EnumerateStateNamesAsync (actorId, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<System.String>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="actorId" Type="Microsoft.ServiceFabric.Actors.ActorId" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="actorId">ID of the actor for which to create enumerable.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<summary>
Creates an enumerable of all the state names associated with specified actor ID.
</summary>
<returns>
A task that represents the asynchronous enumeration operation. The value of TResult
parameter is an enumerable of all state names associated with specified actor.
</returns>
<remarks>
The enumerator returned from actor state provider is safe to use concurrently
with reads and writes to the state provider. It represents a snapshot consistent
view of the state provider.
</remarks>
<exception cref="T:System.OperationCanceledException">The operation was canceled.</exception>
</Docs>
</Member>
<Member MemberName="GetActorsAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.ServiceFabric.Actors.Query.PagedResult<Microsoft.ServiceFabric.Actors.ActorId>> GetActorsAsync (int numItemsToReturn, Microsoft.ServiceFabric.Actors.Query.ContinuationToken continuationToken, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.ServiceFabric.Actors.Query.PagedResult`1<class Microsoft.ServiceFabric.Actors.ActorId>> GetActorsAsync(int32 numItemsToReturn, class Microsoft.ServiceFabric.Actors.Query.ContinuationToken continuationToken, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.GetActorsAsync(System.Int32,Microsoft.ServiceFabric.Actors.Query.ContinuationToken,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function GetActorsAsync (numItemsToReturn As Integer, continuationToken As ContinuationToken, cancellationToken As CancellationToken) As Task(Of PagedResult(Of ActorId))" />
<MemberSignature Language="F#" Value="abstract member GetActorsAsync : int * Microsoft.ServiceFabric.Actors.Query.ContinuationToken * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.ServiceFabric.Actors.Query.PagedResult<Microsoft.ServiceFabric.Actors.ActorId>>" Usage="iActorStateProvider.GetActorsAsync (numItemsToReturn, continuationToken, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.ServiceFabric.Actors.Query.PagedResult<Microsoft.ServiceFabric.Actors.ActorId>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="numItemsToReturn" Type="System.Int32" />
<Parameter Name="continuationToken" Type="Microsoft.ServiceFabric.Actors.Query.ContinuationToken" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="numItemsToReturn">Number of items requested to be returned.</param>
<param name="continuationToken">
A continuation token to start querying the results from.
A null value of continuation token means start returning values form the beginning.
</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<summary>
Gets the requested number of ActorID's from the state provider.
</summary>
<returns>A task that represents the asynchronous operation of call to server.</returns>
<remarks>
The <paramref name="continuationToken" /> is relative to the state of actor state provider
at the time of invocation of this API. If the state of actor state provider changes (i.e.
new actors are activated or existing actors are deleted) in between calls to this API and
the continuation token from previous call (before the state was modified) is supplied, the
result may contain entries that were already fetched in previous calls.
</remarks>
<exception cref="T:System.OperationCanceledException">The operation was canceled.</exception>
</Docs>
</Member>
<Member MemberName="GetRemindersAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.ServiceFabric.Actors.Query.ReminderPagedResult<System.Collections.Generic.KeyValuePair<Microsoft.ServiceFabric.Actors.ActorId,System.Collections.Generic.List<Microsoft.ServiceFabric.Actors.Runtime.ActorReminderState>>>> GetRemindersAsync (int numItemsToReturn, Microsoft.ServiceFabric.Actors.ActorId actorId, Microsoft.ServiceFabric.Actors.Query.ContinuationToken continuationToken, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.ServiceFabric.Actors.Query.ReminderPagedResult`1<valuetype System.Collections.Generic.KeyValuePair`2<class Microsoft.ServiceFabric.Actors.ActorId, class System.Collections.Generic.List`1<class Microsoft.ServiceFabric.Actors.Runtime.ActorReminderState>>>> GetRemindersAsync(int32 numItemsToReturn, class Microsoft.ServiceFabric.Actors.ActorId actorId, class Microsoft.ServiceFabric.Actors.Query.ContinuationToken continuationToken, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.GetRemindersAsync(System.Int32,Microsoft.ServiceFabric.Actors.ActorId,Microsoft.ServiceFabric.Actors.Query.ContinuationToken,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function GetRemindersAsync (numItemsToReturn As Integer, actorId As ActorId, continuationToken As ContinuationToken, cancellationToken As CancellationToken) As Task(Of ReminderPagedResult(Of KeyValuePair(Of ActorId, List(Of ActorReminderState))))" />
<MemberSignature Language="F#" Value="abstract member GetRemindersAsync : int * Microsoft.ServiceFabric.Actors.ActorId * Microsoft.ServiceFabric.Actors.Query.ContinuationToken * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.ServiceFabric.Actors.Query.ReminderPagedResult<System.Collections.Generic.KeyValuePair<Microsoft.ServiceFabric.Actors.ActorId, System.Collections.Generic.List<Microsoft.ServiceFabric.Actors.Runtime.ActorReminderState>>>>" Usage="iActorStateProvider.GetRemindersAsync (numItemsToReturn, actorId, continuationToken, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.ServiceFabric.Actors.Query.ReminderPagedResult<System.Collections.Generic.KeyValuePair<Microsoft.ServiceFabric.Actors.ActorId,System.Collections.Generic.List<Microsoft.ServiceFabric.Actors.Runtime.ActorReminderState>>>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="numItemsToReturn" Type="System.Int32" />
<Parameter Name="actorId" Type="Microsoft.ServiceFabric.Actors.ActorId" />
<Parameter Name="continuationToken" Type="Microsoft.ServiceFabric.Actors.Query.ContinuationToken" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="numItemsToReturn">Number of items requested to be returned.</param>
<param name="actorId">ActorId for which reminders to be fetched. A null value indicates all actors in the service.</param>
<param name="continuationToken">
A continuation token to start querying the results from.
A null value of continuation token means start returning values form the beginning.
</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<summary>
Gets the list of reminders from the state provider
</summary>
<returns>A task that represents the asynchronous operation of call to server.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.OperationCanceledException">The operation was canceled.</exception>
</Docs>
</Member>
<Member MemberName="Initialize">
<MemberSignature Language="C#" Value="public void Initialize (Microsoft.ServiceFabric.Actors.Runtime.ActorTypeInformation actorTypeInformation);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Initialize(class Microsoft.ServiceFabric.Actors.Runtime.ActorTypeInformation actorTypeInformation) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.Initialize(Microsoft.ServiceFabric.Actors.Runtime.ActorTypeInformation)" />
<MemberSignature Language="VB.NET" Value="Public Sub Initialize (actorTypeInformation As ActorTypeInformation)" />
<MemberSignature Language="F#" Value="abstract member Initialize : Microsoft.ServiceFabric.Actors.Runtime.ActorTypeInformation -> unit" Usage="iActorStateProvider.Initialize actorTypeInformation" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="actorTypeInformation" Type="Microsoft.ServiceFabric.Actors.Runtime.ActorTypeInformation" />
</Parameters>
<Docs>
<param name="actorTypeInformation">Type information of the actor class</param>
<summary>
Initializes the actor state provider with type information
of the actor type associated with it.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="LoadRemindersAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.ServiceFabric.Actors.Runtime.IActorReminderCollection> LoadRemindersAsync (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.ServiceFabric.Actors.Runtime.IActorReminderCollection> LoadRemindersAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.LoadRemindersAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function LoadRemindersAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of IActorReminderCollection)" />
<MemberSignature Language="F#" Value="abstract member LoadRemindersAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.ServiceFabric.Actors.Runtime.IActorReminderCollection>" Usage="iActorStateProvider.LoadRemindersAsync cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.ServiceFabric.Actors.Runtime.IActorReminderCollection></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken">Cancellation token for asynchronous load operation.</param>
<summary>
Loads all the reminders contained in the actor state provider.
</summary>
<returns>
A task that represents the asynchronous load operation. The value of TResult
parameter is a collection of all actor reminders contained in the actor state provider.
</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.OperationCanceledException">The operation was canceled.</exception>
</Docs>
</Member>
<Member MemberName="LoadStateAsync<T>">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<T> LoadStateAsync<T> (Microsoft.ServiceFabric.Actors.ActorId actorId, string stateName, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<!!T> LoadStateAsync<T>(class Microsoft.ServiceFabric.Actors.ActorId actorId, string stateName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.LoadStateAsync``1(Microsoft.ServiceFabric.Actors.ActorId,System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function LoadStateAsync(Of T) (actorId As ActorId, stateName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of T)" />
<MemberSignature Language="F#" Value="abstract member LoadStateAsync : Microsoft.ServiceFabric.Actors.ActorId * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'T>" Usage="iActorStateProvider.LoadStateAsync (actorId, stateName, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<T></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="actorId" Type="Microsoft.ServiceFabric.Actors.ActorId" />
<Parameter Name="stateName" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<typeparam name="T">Type of value of actor state associated with given state name.</typeparam>
<param name="actorId">ID of the actor for which to load the state.</param>
<param name="stateName">Name of the actor state to load.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<summary>
Loads the actor state associated with the specified state name for the specified actor ID.
</summary>
<returns>
A task that represents the asynchronous load operation. The value of TResult
parameter contains value of actor state associated with given state name.
</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.Collections.Generic.KeyNotFoundException">Actor state associated with specified state name does not exist.</exception>
<exception cref="T:System.OperationCanceledException">The operation was canceled.</exception>
</Docs>
</Member>
<Member MemberName="ReminderCallbackCompletedAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task ReminderCallbackCompletedAsync (Microsoft.ServiceFabric.Actors.ActorId actorId, Microsoft.ServiceFabric.Actors.Runtime.IActorReminder reminder, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task ReminderCallbackCompletedAsync(class Microsoft.ServiceFabric.Actors.ActorId actorId, class Microsoft.ServiceFabric.Actors.Runtime.IActorReminder reminder, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.ReminderCallbackCompletedAsync(Microsoft.ServiceFabric.Actors.ActorId,Microsoft.ServiceFabric.Actors.Runtime.IActorReminder,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function ReminderCallbackCompletedAsync (actorId As ActorId, reminder As IActorReminder, Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="abstract member ReminderCallbackCompletedAsync : Microsoft.ServiceFabric.Actors.ActorId * Microsoft.ServiceFabric.Actors.Runtime.IActorReminder * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="iActorStateProvider.ReminderCallbackCompletedAsync (actorId, reminder, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="actorId" Type="Microsoft.ServiceFabric.Actors.ActorId" />
<Parameter Name="reminder" Type="Microsoft.ServiceFabric.Actors.Runtime.IActorReminder" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="actorId">ID of the actor which own reminder</param>
<param name="reminder">Actor reminder that completed successfully.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<summary>
Invoked when a reminder fires and finishes executing its callback
<see cref="M:Microsoft.ServiceFabric.Actors.Runtime.IRemindable.ReceiveReminderAsync(System.String,System.Byte[],System.TimeSpan,System.TimeSpan)" /> successfully.
</summary>
<returns>
A task that represents the asynchronous reminder callback completed notification processing.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RemoveActorAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task RemoveActorAsync (Microsoft.ServiceFabric.Actors.ActorId actorId, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task RemoveActorAsync(class Microsoft.ServiceFabric.Actors.ActorId actorId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.RemoveActorAsync(Microsoft.ServiceFabric.Actors.ActorId,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function RemoveActorAsync (actorId As ActorId, Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="abstract member RemoveActorAsync : Microsoft.ServiceFabric.Actors.ActorId * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="iActorStateProvider.RemoveActorAsync (actorId, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="actorId" Type="Microsoft.ServiceFabric.Actors.ActorId" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="actorId">ID of the actor for which to remove state.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<summary>
Removes all the existing states and reminders associated with specified actor ID atomically.
</summary>
<returns>A task that represents the asynchronous remove operation.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.OperationCanceledException">The operation was canceled.</exception>
</Docs>
</Member>
<Member MemberName="SaveReminderAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task SaveReminderAsync (Microsoft.ServiceFabric.Actors.ActorId actorId, Microsoft.ServiceFabric.Actors.Runtime.IActorReminder reminder, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task SaveReminderAsync(class Microsoft.ServiceFabric.Actors.ActorId actorId, class Microsoft.ServiceFabric.Actors.Runtime.IActorReminder reminder, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.SaveReminderAsync(Microsoft.ServiceFabric.Actors.ActorId,Microsoft.ServiceFabric.Actors.Runtime.IActorReminder,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function SaveReminderAsync (actorId As ActorId, reminder As IActorReminder, Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="abstract member SaveReminderAsync : Microsoft.ServiceFabric.Actors.ActorId * Microsoft.ServiceFabric.Actors.Runtime.IActorReminder * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="iActorStateProvider.SaveReminderAsync (actorId, reminder, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="actorId" Type="Microsoft.ServiceFabric.Actors.ActorId" />
<Parameter Name="reminder" Type="Microsoft.ServiceFabric.Actors.Runtime.IActorReminder" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="actorId">ID of the actor for which to save the reminder.</param>
<param name="reminder">Actor reminder to save.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<summary>
Saves the specified actor ID reminder. If an actor reminder with
given name does not exist, it adds the actor reminder otherwise
existing actor reminder with same name is updated.
</summary>
<returns>A task that represents the asynchronous save operation.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.OperationCanceledException">The operation was canceled.</exception>
</Docs>
</Member>
<Member MemberName="SaveStateAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task SaveStateAsync (Microsoft.ServiceFabric.Actors.ActorId actorId, System.Collections.Generic.IReadOnlyCollection<Microsoft.ServiceFabric.Actors.Runtime.ActorStateChange> stateChanges, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task SaveStateAsync(class Microsoft.ServiceFabric.Actors.ActorId actorId, class System.Collections.Generic.IReadOnlyCollection`1<class Microsoft.ServiceFabric.Actors.Runtime.ActorStateChange> stateChanges, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.SaveStateAsync(Microsoft.ServiceFabric.Actors.ActorId,System.Collections.Generic.IReadOnlyCollection{Microsoft.ServiceFabric.Actors.Runtime.ActorStateChange},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function SaveStateAsync (actorId As ActorId, stateChanges As IReadOnlyCollection(Of ActorStateChange), Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="abstract member SaveStateAsync : Microsoft.ServiceFabric.Actors.ActorId * System.Collections.Generic.IReadOnlyCollection<Microsoft.ServiceFabric.Actors.Runtime.ActorStateChange> * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="iActorStateProvider.SaveStateAsync (actorId, stateChanges, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="actorId" Type="Microsoft.ServiceFabric.Actors.ActorId" />
<Parameter Name="stateChanges" Type="System.Collections.Generic.IReadOnlyCollection<Microsoft.ServiceFabric.Actors.Runtime.ActorStateChange>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="actorId">ID of the actor for which to save the state changes.</param>
<param name="stateChanges">Collection of state changes to save.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<summary>
Saves the specified set of actor state changes for the specified actor ID atomically.
</summary>
<returns>A task that represents the asynchronous save operation.</returns>
<remarks>
The collection of state changes should contain only one item for a given state name.
The save operation will fail on trying to add an actor state which already exists
or update/remove an actor state which does not exist.
</remarks>
<exception cref="T:System.InvalidOperationException">
When <see cref="T:Microsoft.ServiceFabric.Actors.Runtime.StateChangeKind" /> is <see cref="F:Microsoft.ServiceFabric.Actors.Runtime.StateChangeKind.None" /></exception>
<exception cref="T:System.OperationCanceledException">The operation was canceled.</exception>
</Docs>
</Member>
</Members>
</Type>