# Microsoft.Orleans.Reminders

10.0.0 | net10.0

[NuGet package](https://www.nuget.org/packages/Microsoft.Orleans.Reminders)

## Orleans

- [GrainReminderExtensions](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleans.grainreminderextensions/) - Extension methods for accessing reminders from a [Grain](/orleans/docs/api/csharp/microsoft.orleans.core.abstractions/orleans.grain/) or [IGrainBase](/orleans/docs/api/csharp/microsoft.orleans.core.abstractions/orleans.igrainbase/) implementation.
- [IRemindable](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleans.iremindable/) - Callback interface that grains must implement in order to be able to register and receive Reminders.
- [IReminderService](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleans.ireminderservice/) - Functionality for managing reminders.
- [IReminderTable](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleans.iremindertable/) - Interface for implementations of the underlying storage for reminder data: Azure Table, SQL, development emulator grain, and a mock implementation. Defined as a grain interface for the development emulator grain case.
- [ReminderEntry](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleans.reminderentry/) - Represents a reminder table entry.
- [ReminderTableData](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleans.remindertabledata/) - Represents a collection of reminder table entries.

## Orleans.Hosting

- [ReminderOptions](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleans.hosting.reminderoptions/) - Options for the reminder service.
- [SiloBuilderReminderExtensions](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleans.hosting.silobuilderreminderextensions/) - Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all .NET classes; it is the root of the type hierarchy.
- [SiloBuilderReminderMemoryExtensions](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleans.hosting.silobuilderremindermemoryextensions/) - Extensions to [ISiloBuilder](/orleans/docs/api/csharp/microsoft.orleans.runtime/orleans.hosting.isilobuilder/) for configuring the in-memory reminder provider.

## Orleans.Reminders

- [ReminderTimeProviderNames](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleans.reminders.remindertimeprovidernames/) - Service key used to resolve the reminder subsystem's `System.TimeProvider` from keyed dependency injection. See [TimeProviderNames](/orleans/docs/api/csharp/microsoft.orleans.core/orleans.runtime.timeprovidernames/) for the core runtime areas.
- [RSErrorCode](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleans.reminders.rserrorcode/) - The set of error codes used by the Orleans runtime libraries for logging errors. For Reminders.

## Orleans.Reminders.Diagnostics

- [LocalReminderScheduleChanged](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleans.reminders.diagnostics.reminderevents.localreminderschedulechanged/) - Event payload for when a local reminder schedule is invalidated and must be re-armed.
- [LocalReminderStarted](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleans.reminders.diagnostics.reminderevents.localreminderstarted/) - Event payload for when a silo starts a local timer for a reminder instance.
- [LocalReminderStopped](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleans.reminders.diagnostics.reminderevents.localreminderstopped/) - Event payload for when a silo stops a local timer for a reminder instance.
- [LocalReminderStopReason](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleans.reminders.diagnostics.reminderevents.localreminderstopreason/) - The reason a local reminder timer stopped.
- [LocalReminderTickWaitArmed](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleans.reminders.diagnostics.reminderevents.localremindertickwaitarmed/) - Event payload for when a local reminder has armed the wait for its next tick.
- [Registered](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleans.reminders.diagnostics.reminderevents.registered/) - Event payload for when a reminder is registered or updated.
- [ReminderEvent](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleans.reminders.diagnostics.reminderevents.reminderevent/) - The base class used for reminder diagnostic events.
- [ReminderEvents](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleans.reminders.diagnostics.reminderevents/) - Provides the diagnostic listener and event payload types for Orleans reminder events.
- [ReminderServiceEvent](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleans.reminders.diagnostics.reminderevents.reminderserviceevent/) - The base class used for reminder service diagnostic events.
- [ReminderServiceStarted](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleans.reminders.diagnostics.reminderevents.reminderservicestarted/) - Event payload for when a reminder service completes startup and is ready for reminder operations.
- [TickCompleted](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleans.reminders.diagnostics.reminderevents.tickcompleted/) - Event payload for when a reminder tick has completed successfully.
- [TickFailed](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleans.reminders.diagnostics.reminderevents.tickfailed/) - Event payload for when a reminder tick has failed.
- [TickFiring](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleans.reminders.diagnostics.reminderevents.tickfiring/) - Event payload for when a reminder tick is about to fire.
- [Unregistered](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleans.reminders.diagnostics.reminderevents.unregistered/) - Event payload for when a reminder is unregistered.

## Orleans.Runtime

- [IGrainReminder](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleans.runtime.igrainreminder/) - Handle for a persistent Reminder.
- [ReminderException](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleans.runtime.reminderexception/) - Exception related to Orleans Reminder functions or Reminder service.
- [TickStatus](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleans.runtime.tickstatus/) - The status of a tick when the tick is delivered to the registrar grain. In case of failures, it may happen that a tick is not delivered on time. The app can notice such missed ticks as follows. Upon receiving a tick, the app can calculate the theoretical number of ticks since start of the reminder as: curCount = (Now - FirstTickTime) / Period The app can keep track of it as 'count'. Upon receiving a tick, the number of missed ticks = curCount - count - 1 Thereafter, the app can set count = curCount

## Orleans.Timers

- [IReminderRegistry](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleans.timers.ireminderregistry/) - Functionality for managing reminders.

## OrleansCodeGen.Orleans

- [Codec_Invokable_IRemindable_GrainReference_6461BF2F](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleanscodegen.orleans.codec-invokable-iremindable-grainreference-6461bf2f/) - Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all .NET classes; it is the root of the type hierarchy.
- [Codec_Invokable_IReminderService_GrainReference_1281C86D](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleanscodegen.orleans.codec-invokable-ireminderservice-grainreference-1281c86d/) - Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all .NET classes; it is the root of the type hierarchy.
- [Codec_Invokable_IReminderService_GrainReference_419EB51E](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleanscodegen.orleans.codec-invokable-ireminderservice-grainreference-419eb51e/) - Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all .NET classes; it is the root of the type hierarchy.
- [Codec_Invokable_IReminderService_GrainReference_5CF78F8A](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleanscodegen.orleans.codec-invokable-ireminderservice-grainreference-5cf78f8a/) - Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all .NET classes; it is the root of the type hierarchy.
- [Codec_Invokable_IReminderService_GrainReference_A7AF84A8](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleanscodegen.orleans.codec-invokable-ireminderservice-grainreference-a7af84a8/) - Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all .NET classes; it is the root of the type hierarchy.
- [Codec_Invokable_IReminderService_GrainReference_AC622EEB](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleanscodegen.orleans.codec-invokable-ireminderservice-grainreference-ac622eeb/) - Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all .NET classes; it is the root of the type hierarchy.
- [Codec_Invokable_IReminderService_GrainReference_DCFCA00D](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleanscodegen.orleans.codec-invokable-ireminderservice-grainreference-dcfca00d/) - Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all .NET classes; it is the root of the type hierarchy.
- [Codec_ReminderEntry](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleanscodegen.orleans.codec-reminderentry/) - Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all .NET classes; it is the root of the type hierarchy.
- [Codec_ReminderTableData](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleanscodegen.orleans.codec-remindertabledata/) - Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all .NET classes; it is the root of the type hierarchy.
- [Copier_Invokable_IRemindable_GrainReference_6461BF2F](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleanscodegen.orleans.copier-invokable-iremindable-grainreference-6461bf2f/) - Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all .NET classes; it is the root of the type hierarchy.
- [Copier_Invokable_IReminderService_GrainReference_1281C86D](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleanscodegen.orleans.copier-invokable-ireminderservice-grainreference-1281c86d/) - Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all .NET classes; it is the root of the type hierarchy.
- [Copier_Invokable_IReminderService_GrainReference_419EB51E](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleanscodegen.orleans.copier-invokable-ireminderservice-grainreference-419eb51e/) - Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all .NET classes; it is the root of the type hierarchy.
- [Copier_Invokable_IReminderService_GrainReference_5CF78F8A](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleanscodegen.orleans.copier-invokable-ireminderservice-grainreference-5cf78f8a/) - Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all .NET classes; it is the root of the type hierarchy.
- [Copier_Invokable_IReminderService_GrainReference_A7AF84A8](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleanscodegen.orleans.copier-invokable-ireminderservice-grainreference-a7af84a8/) - Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all .NET classes; it is the root of the type hierarchy.
- [Copier_Invokable_IReminderService_GrainReference_AC622EEB](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleanscodegen.orleans.copier-invokable-ireminderservice-grainreference-ac622eeb/) - Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all .NET classes; it is the root of the type hierarchy.
- [Copier_Invokable_IReminderService_GrainReference_DCFCA00D](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleanscodegen.orleans.copier-invokable-ireminderservice-grainreference-dcfca00d/) - Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all .NET classes; it is the root of the type hierarchy.
- [Copier_ReminderEntry](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleanscodegen.orleans.copier-reminderentry/) - Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all .NET classes; it is the root of the type hierarchy.
- [Copier_ReminderTableData](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleanscodegen.orleans.copier-remindertabledata/) - Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all .NET classes; it is the root of the type hierarchy.
- [Invokable_IRemindable_GrainReference_6461BF2F](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleanscodegen.orleans.invokable-iremindable-grainreference-6461bf2f/) - Base class for requests for methods which return `System.Threading.Tasks.ValueTask`.
- [Invokable_IReminderService_GrainReference_1281C86D](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleanscodegen.orleans.invokable-ireminderservice-grainreference-1281c86d/) - Base class for requests for methods which return `System.Threading.Tasks.Task-1`.
- [Invokable_IReminderService_GrainReference_419EB51E](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleanscodegen.orleans.invokable-ireminderservice-grainreference-419eb51e/) - Base class for requests for methods which return `System.Threading.Tasks.Task-1`.
- [Invokable_IReminderService_GrainReference_5CF78F8A](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleanscodegen.orleans.invokable-ireminderservice-grainreference-5cf78f8a/) - Base class for requests for methods which return `System.Threading.Tasks.ValueTask`.
- [Invokable_IReminderService_GrainReference_A7AF84A8](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleanscodegen.orleans.invokable-ireminderservice-grainreference-a7af84a8/) - Base class for requests for methods which return `System.Threading.Tasks.ValueTask`.
- [Invokable_IReminderService_GrainReference_AC622EEB](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleanscodegen.orleans.invokable-ireminderservice-grainreference-ac622eeb/) - Base class for requests for methods which return `System.Threading.Tasks.Task-1`.
- [Invokable_IReminderService_GrainReference_DCFCA00D](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleanscodegen.orleans.invokable-ireminderservice-grainreference-dcfca00d/) - Base class for requests for methods which return `System.Threading.Tasks.ValueTask`.

## OrleansCodeGen.Orleans.Runtime

- [Codec_ReminderException](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleanscodegen.orleans.runtime.codec-reminderexception/) - Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all .NET classes; it is the root of the type hierarchy.
- [Codec_TickStatus](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleanscodegen.orleans.runtime.codec-tickstatus/) - Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all .NET classes; it is the root of the type hierarchy.
- [Copier_ReminderException](/orleans/docs/api/csharp/microsoft.orleans.reminders/orleanscodegen.orleans.runtime.copier-reminderexception/) - Default copier implementation for (rarely copied) exception classes