IRemindable.ReceiveReminderAsync(String, Byte[], TimeSpan, TimeSpan) Method

Definition

The reminder call back invoked when an actor reminder is triggered.

public System.Threading.Tasks.Task ReceiveReminderAsync (string reminderName, byte[] state, TimeSpan dueTime, TimeSpan period);
abstract member ReceiveReminderAsync : string * byte[] * TimeSpan * TimeSpan -> System.Threading.Tasks.Task
Public Function ReceiveReminderAsync (reminderName As String, state As Byte(), dueTime As TimeSpan, period As TimeSpan) As Task

Parameters

reminderName
String

The name of reminder provided during registration

state
Byte[]

The user state provided during registration.

dueTime
TimeSpan

The invocation due time provided during registration.

period
TimeSpan

The invocation period provided during registration.

Returns

A task that represents the asynchronous operation performed by this callback.

Remarks

The state of this actor is saved by the actor runtime upon completion of the task returned by this method. If an error occurs while saving the state, then all state cached by this actor's StateManager will be discarded and reloaded from previously saved state when the next actor method or reminder invocation occurs.

Applies to