View Source

Class UmbracoPipelineFilter

Inheritance

object

Namespace: Umbraco.Cms.Web.Common.ApplicationBuilder

Assembly: Umbraco.Web.Common.dll

Syntax

public class UmbracoPipelineFilter : IUmbracoPipelineFilter

Constructors

UmbracoPipelineFilter(string)

Initializes a new instance of the UmbracoPipelineFilter class.

Declaration

public UmbracoPipelineFilter(string name)

Parameters

Type	Name	Description
string	name	The name.

UmbracoPipelineFilter(string, Action<IApplicationBuilder>?, Action<IApplicationBuilder>?, Action<IApplicationBuilder>?, Action<IApplicationBuilder>?, Action<IApplicationBuilder>?, Action<IEndpointRouteBuilder>?, Action<IEndpointRouteBuilder>?)

Initializes a new instance of the UmbracoPipelineFilter class.

Declaration

public UmbracoPipelineFilter(string name, Action<IApplicationBuilder>? prePipeline = null, Action<IApplicationBuilder>? preRouting = null, Action<IApplicationBuilder>? postRouting = null, Action<IApplicationBuilder>? postPipeline = null, Action<IApplicationBuilder>? endpoints = null, Action<IEndpointRouteBuilder>? preMapEndpoints = null, Action<IEndpointRouteBuilder>? postMapEndpoints = null)

Parameters

Type	Name	Description
string	name	The name.
Action<IApplicationBuilder>	prePipeline	The pre pipeline callback.
Action<IApplicationBuilder>	preRouting	The pre routing callback.
Action<IApplicationBuilder>	postRouting	The post routing callback.
Action<IApplicationBuilder>	postPipeline	The post pipeline callback.
Action<IApplicationBuilder>	endpoints	The endpoints callback.
Action<IEndpointRouteBuilder>	preMapEndpoints	The pre map endpoints callback.
Action<IEndpointRouteBuilder>	postMapEndpoints	The post map endpoints callback.

Properties

Endpoints

Gets or sets the endpoints callback.

Declaration

public Action<IApplicationBuilder>? Endpoints { get; set; }

Property Value

Type	Description
Action<IApplicationBuilder>	The endpoints callback.

Name

The name of the filter.

Declaration

public string Name { get; }

Property Value

Type	Description
string	The name.

Remarks

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

PostMapEndpoints

Gets or sets the post map endpoints callback.

Declaration

public Action<IEndpointRouteBuilder>? PostMapEndpoints { get; set; }

Property Value

Type	Description
Action<IEndpointRouteBuilder>	The post map endpoints callback.

PostPipeline

Gets or sets the post pipeline callback.

Declaration

public Action<IApplicationBuilder>? PostPipeline { get; set; }

Property Value

Type	Description
Action<IApplicationBuilder>	The post pipeline callback.

PostRouting

Gets or sets the post routing callback.

Declaration

public Action<IApplicationBuilder>? PostRouting { get; set; }

Property Value

Type	Description
Action<IApplicationBuilder>	The post routing callback.

PreMapEndpoints

Gets or sets the pre map endpoints callback.

Declaration

public Action<IEndpointRouteBuilder>? PreMapEndpoints { get; set; }

Property Value

Type	Description
Action<IEndpointRouteBuilder>	The pre map endpoints callback.

PrePipeline

Gets or sets the pre pipeline callback.

Declaration

public Action<IApplicationBuilder>? PrePipeline { get; set; }

Property Value

Type	Description
Action<IApplicationBuilder>	The pre pipeline callback.

PreRouting

Gets or sets the pre routing.

Declaration

public Action<IApplicationBuilder>? PreRouting { get; set; }

Property Value

Type	Description
Action<IApplicationBuilder>	The pre routing.

Methods

OnEndpoints(IApplicationBuilder)

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

Declaration

public void OnEndpoints(IApplicationBuilder app)

Parameters

Type	Name	Description
IApplicationBuilder	app	The application.

OnPostMapEndpoints(IEndpointRouteBuilder)

Executes inside UseEndpoints, after Umbraco registers its endpoints.

Declaration

public void OnPostMapEndpoints(IEndpointRouteBuilder endpoints)

Parameters

Type	Name	Description
IEndpointRouteBuilder	endpoints	The endpoint route builder.

OnPostPipeline(IApplicationBuilder)

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

Declaration

public void OnPostPipeline(IApplicationBuilder app)

Parameters

Type	Name	Description
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

public void OnPostRouting(IApplicationBuilder app)

Parameters

Type	Name	Description
IApplicationBuilder	app	The application.

OnPreMapEndpoints(IEndpointRouteBuilder)

Executes inside UseEndpoints, before Umbraco registers its endpoints.

Declaration

public void OnPreMapEndpoints(IEndpointRouteBuilder endpoints)

Parameters

Type	Name	Description
IEndpointRouteBuilder	endpoints	The endpoint route builder.

OnPrePipeline(IApplicationBuilder)

Executes before any default Umbraco middlewares are registered.

Declaration

public void OnPrePipeline(IApplicationBuilder app)

Parameters

Type	Name	Description
IApplicationBuilder	app	The application.

OnPreRouting(IApplicationBuilder)

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

Declaration

public void OnPreRouting(IApplicationBuilder app)

Parameters

Type	Name	Description
IApplicationBuilder	app	The application.