AppBuilderExtensions.UseHangfireDashboard Method (IAppBuilder, String)

AppBuilderExtensionsUseHangfireDashboard Method (IAppBuilder, String)

Adds Dashboard UI middleware to the OWIN request processing pipeline under the given path, for the Current storage.

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
)

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

Parameters

builder: Type: IAppBuilder
OWIN application builder.
pathMatch: Type: SystemString
Path prefix for middleware to use, e.g. "/hangfire".

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.

Remarks

Please see AppBuilderExtensions for details and examples.

Reference

AppBuilderExtensions Class

UseHangfireDashboard Overload

Hangfire Namespace