Class QuartzDashboardServiceCollectionExtensions

Namespace

Quartz

Assembly

Quartz.Dashboard.dll

Registers the Quartz.NET Dashboard's services.

public static class QuartzDashboardServiceCollectionExtensions

Inheritance

object

QuartzDashboardServiceCollectionExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

AddQuartzDashboard(IServiceCollection, Action<QuartzDashboardOptions>?)

Registers everything the dashboard renders with — its Blazor components, its SignalR hub, the history store and the IQuartzApiClient the pages read — and adds its two plugins to every scheduler in the container.

public static IServiceCollection AddQuartzDashboard(this IServiceCollection services, Action<QuartzDashboardOptions>? configure = null)

Parameters

services IServiceCollection

The service collection.

configure Action<QuartzDashboardOptions>

Configures the dashboard, including the path it is served under.

Returns

IServiceCollection

The same collection, so calls can be chained.

Remarks

No option points the dashboard at a scheduler: it renders the schedulers this application registered. The client is registered with TryAdd, so an application that registers its own IQuartzApiClient first is the one the pages read. Call MapQuartzDashboard() on the built application to map the endpoints.

Exceptions

ArgumentNullException

services is null.