AppBuilderExtensions.UseHangfireDashboard Method (IAppBuilder, String, DashboardOptions, JobStorage)

AppBuilderExtensionsUseHangfireDashboard Method (IAppBuilder, String, DashboardOptions, JobStorage)

Adds Dashboard UI middleware to the OWIN request processing pipeline with the specified parameters.

Namespace: Hangfire
Assembly: Hangfire.Core (in Hangfire.Core.dll) Version: 1.5.0.0

Syntax

public static IAppBuilder UseHangfireDashboard(
	[NotNullAttribute] this IAppBuilder builder,
	[NotNullAttribute] string pathMatch,
	[NotNullAttribute] DashboardOptions options,
	[NotNullAttribute] JobStorage storage
)

<ExtensionAttribute>
Public Shared Function UseHangfireDashboard ( 
	<NotNullAttribute> builder As IAppBuilder,
	<NotNullAttribute> pathMatch As String,
	<NotNullAttribute> options As DashboardOptions,
	<NotNullAttribute> storage As JobStorage
) As IAppBuilder

Parameters

builder: Type: IAppBuilder
OWIN application builder.
pathMatch: Type: SystemString
Path prefix for middleware to use, e.g. "/hangfire".
options: Type: HangfireDashboardOptions
Options for Dashboard UI.
storage: Type: HangfireJobStorage
Job storage to use by Dashboard IO.

Return Value

Type: IAppBuilder

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IAppBuilder. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Exceptions

Exception	Condition
ArgumentNullException	builder is null.
ArgumentNullException	pathMatch is null.
ArgumentNullException	options is null.
ArgumentNullException	storage is null.

Remarks

Please see AppBuilderExtensions for details and examples.

Reference

AppBuilderExtensions Class

UseHangfireDashboard Overload

Hangfire Namespace