Quartz.NET 4.x API reference

Generated from the XML documentation comments of the ten shipped packages. It is the reference: what a type is, what every member takes and returns, and the remarks that say why. The prose - quick start, tutorial, configuration, how-tos - lives on the documentation site, and the migration guide maps the 3.x names onto these.

This set rolls forward with every 4.x minor release. The 3.x reference stays at /apidoc/3.0.

Where to start

Schedule something JobBuilder, TriggerBuilder, IScheduler
Register it with a host QuartzServiceCollectionExtensions.AddQuartz, IQuartzBuilder
Do without a container QuartzSchedulerBuilder
Write an extension the Quartz.Extensibility namespace

The packages

Package Namespaces
Quartz - the scheduler, its hosting and dependency injection, the in-memory and ADO.NET job stores, and System.Text.Json serialization Quartz, Quartz.Diagnostics, Quartz.Extensibility, Quartz.Impl, Quartz.Impl.AdoJobStore, Quartz.Impl.Calendar, Quartz.Impl.Triggers, Quartz.Listeners, Quartz.Serialization.SystemTextJson
Quartz.AspNetCore - the HTTP API and the ASP.NET Core wiring around it QuartzAspNetCoreConfigurationExtensions, QuartzHttpApiOptions
Quartz.Aspire - an Aspire connection name turned into a persistent job store QuartzAspireHostApplicationBuilderExtensions, QuartzAspireSettings
Quartz.Dashboard - the Blazor dashboard QuartzDashboardOptions, Quartz.Dashboard.Hubs, Quartz.Dashboard.Plugins, Quartz.Dashboard.Services
Quartz.Extensions.Redis - a Redis lock handler for a clustered scheduler Quartz.Extensions.Redis, RedisLockHandlerOptions
Quartz.HttpClient - an IScheduler that talks to the HTTP API HttpScheduler
Quartz.Jobs - ready-made jobs Quartz.Jobs
Quartz.Plugins - history logging, and jobs loaded from XML or JSON Quartz.Plugins.History, Quartz.Plugins.Json, Quartz.Plugins.Xml
Quartz.Plugins.TimeZoneConverter - IANA and Windows time zone ids either way round TimeZonePluginConfigurationExtensions
Quartz.Serialization.Newtonsoft - Newtonsoft.Json for what a job store persists Quartz.Serialization.Newtonsoft

The dashboard's Blazor components are left out: the Razor compiler emits a public class per .razor file, but they are the dashboard's UI rather than API anyone calls.