IReminderRegistry

1. Documentation
2. API reference
3. Microsoft.Orleans.Reminders
4. IReminderRegistry

interface

Namespace: Orleans.Timers

NuGetSourceMarkdown

Functionality for managing reminders.

public interface IReminderRegistry : IGrainServiceClient<IReminderService>

Methods

• GetReminder(GrainId, string) Gets the reminder with the specified name which is registered to the currently active grain.
• GetReminder(GrainId, string, CancellationToken) Gets a reminder registered to the specified grain.
• GetReminders(GrainId) Gets all reminders which are currently registered to the active grain.
• GetReminders(GrainId, CancellationToken) Gets all reminders registered to the specified grain.
• RegisterOrUpdateReminder(GrainId, string, TimeSpan, TimeSpan) Register or update the reminder with the specified name for the currently active grain.
• RegisterOrUpdateReminder(GrainId, string, TimeSpan, TimeSpan, CancellationToken) Registers or updates a reminder for the specified grain.
• UnregisterReminder(GrainId, IGrainReminder) Unregisters a reminder from the currently active grain.
• UnregisterReminder(GrainId, IGrainReminder, CancellationToken) Unregisters a reminder from the specified grain.