View Source

Interface IUmbracoPipelineFilter

Used to modify the Microsoft.AspNetCore.Builder.IApplicationBuilder pipeline before and after Umbraco registers its middlewares.

Namespace: Umbraco.Cms.Web.Common.ApplicationBuilder

Assembly: Umbraco.Web.Common.dll

Syntax

public interface IUmbracoPipelineFilter

Remarks

Mainly used for package developers.

Properties

Name

The name of the filter.

Declaration

string Name { get; }

Property Value

Type	Description
System.String	The name.

Remarks

This can be used by developers to see what is registered and if anything should be re-ordered, removed, etc...

Methods

OnEndpoints(IApplicationBuilder)

Executes after the middlewares are registered and just before any Umbraco endpoints are declared.

Declaration

void OnEndpoints(IApplicationBuilder app)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Builder.IApplicationBuilder	app	The application.

OnPostPipeline(IApplicationBuilder)

Executes after core Umbraco middlewares are registered and before any endpoints are declared.

Declaration

void OnPostPipeline(IApplicationBuilder app)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Builder.IApplicationBuilder	app	The application.

OnPostRouting(IApplicationBuilder)

Executes after the routing middleware is registered and just before the authentication and authorization middlewares are registered. This can be used to add CORS policies.

Declaration

virtual void OnPostRouting(IApplicationBuilder app)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Builder.IApplicationBuilder	app	The application.

OnPrePipeline(IApplicationBuilder)

Executes before any default Umbraco middlewares are registered.

Declaration

void OnPrePipeline(IApplicationBuilder app)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Builder.IApplicationBuilder	app	The application.

OnPreRouting(IApplicationBuilder)

Executes after static files middlewares are registered and just before the routing middleware is registered.

Declaration

virtual void OnPreRouting(IApplicationBuilder app)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Builder.IApplicationBuilder	app	The application.