IReminderService

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

interface

Namespace: Orleans

NuGetSourceMarkdown

Functionality for managing reminders.

public interface IReminderService : ISystemTarget, IAddressable, IGrainService

Methods

• GetReminder(GrainId, string) Gets the reminder registered to the specified grain with the provided name.
• GetReminder(GrainId, string, CancellationToken) Gets the reminder registered to the specified grain with the provided name.
• GetReminders(GrainId) Gets all reminders registered for the specified grain.
• GetReminders(GrainId, CancellationToken) Gets all reminders registered for the specified grain.
• RegisterOrUpdateReminder(GrainId, string, TimeSpan, TimeSpan) Registers a new reminder or updates an existing one.
• RegisterOrUpdateReminder(GrainId, string, TimeSpan, TimeSpan, CancellationToken) Registers a new reminder or updates an existing one.
• Start Starts the service.
• Start(CancellationToken) Starts the service.
• Stop Stops the service.
• Stop(CancellationToken) Stops the service.
• UnregisterReminder(IGrainReminder) Unregisters the specified reminder.
• UnregisterReminder(IGrainReminder, CancellationToken) Unregisters the specified reminder.