IReminderRegistry.RegisterOrUpdateReminder(GrainId, string, TimeSpan, TimeSpan)

1. Documentation
2. API reference
3. Microsoft.Orleans.Reminders
4. IReminderRegistry
5. Methods
6. RegisterOrUpdateReminder(GrainId, string, TimeSpan, TimeSpan)

Markdown

RegisterOrUpdateReminder(GrainId, string, TimeSpan, TimeSpan)

abstract

public abstract Task<IGrainReminder> RegisterOrUpdateReminder(GrainId callingGrainId, string reminderName, TimeSpan dueTime, TimeSpan period)

Register or update the reminder with the specified name for the currently active grain.

Parameters

callingGrainIdGrainId

The ID of the the currently executing grain

reminderNamestring

The reminder name.

dueTimeTimeSpan

The amount of time to delay before initially invoking the reminder. A value of System.TimeSpan.Zero means the first tick is scheduled immediately; negative, infinite, or values which exceed the remaining System.DateTime range are rejected.

periodTimeSpan

The time interval between invocations of the reminder. The value must be at least ReminderOptions; smaller values and System.Threading.Timeout.InfiniteTimeSpan are rejected.

Returns

The reminder.