Search Results for

    Show / Hide Table of Contents
    View Source

    Class UmbracoPipelineFilter

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

    Inheritance
    System.Object
    Namespace: Umbraco.Cms.Web.Common.ApplicationBuilder
    Assembly: Umbraco.Web.Common.dll
    Syntax
    public class UmbracoPipelineFilter : IUmbracoPipelineFilter
    Remarks

    Mainly used for package developers.

    Constructors

    View Source

    UmbracoPipelineFilter(String)

    Initializes a new instance of the UmbracoPipelineFilter class.

    Declaration
    public UmbracoPipelineFilter(string name)
    Parameters
    Type Name Description
    System.String name

    The name.

    View Source

    UmbracoPipelineFilter(String, Nullable<Action<IApplicationBuilder>>, Nullable<Action<IApplicationBuilder>>, Nullable<Action<IApplicationBuilder>>, Nullable<Action<IApplicationBuilder>>, Nullable<Action<IApplicationBuilder>>)

    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)
    Parameters
    Type Name Description
    System.String name

    The name.

    System.Nullable<Action<Microsoft.AspNetCore.Builder.IApplicationBuilder>> prePipeline

    The pre pipeline callback.

    System.Nullable<Action<Microsoft.AspNetCore.Builder.IApplicationBuilder>> preRouting

    The pre routing callback.

    System.Nullable<Action<Microsoft.AspNetCore.Builder.IApplicationBuilder>> postRouting

    The post routing callback.

    System.Nullable<Action<Microsoft.AspNetCore.Builder.IApplicationBuilder>> postPipeline

    The post pipeline callback.

    System.Nullable<Action<Microsoft.AspNetCore.Builder.IApplicationBuilder>> endpoints

    The endpoints callback.

    Properties

    View Source

    Endpoints

    Gets or sets the endpoints callback.

    Declaration
    public Action<IApplicationBuilder>? Endpoints { get; set; }
    Property Value
    Type Description
    System.Nullable<Action<Microsoft.AspNetCore.Builder.IApplicationBuilder>>

    The endpoints callback.

    View Source

    Name

    The name of the filter.

    Declaration
    public 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...

    View Source

    PostPipeline

    Gets or sets the post pipeline callback.

    Declaration
    public Action<IApplicationBuilder>? PostPipeline { get; set; }
    Property Value
    Type Description
    System.Nullable<Action<Microsoft.AspNetCore.Builder.IApplicationBuilder>>

    The post pipeline callback.

    View Source

    PostRouting

    Gets or sets the post routing callback.

    Declaration
    public Action<IApplicationBuilder>? PostRouting { get; set; }
    Property Value
    Type Description
    System.Nullable<Action<Microsoft.AspNetCore.Builder.IApplicationBuilder>>

    The post routing callback.

    View Source

    PrePipeline

    Gets or sets the pre pipeline callback.

    Declaration
    public Action<IApplicationBuilder>? PrePipeline { get; set; }
    Property Value
    Type Description
    System.Nullable<Action<Microsoft.AspNetCore.Builder.IApplicationBuilder>>

    The pre pipeline callback.

    View Source

    PreRouting

    Gets or sets the pre routing.

    Declaration
    public Action<IApplicationBuilder>? PreRouting { get; set; }
    Property Value
    Type Description
    System.Nullable<Action<Microsoft.AspNetCore.Builder.IApplicationBuilder>>

    The pre routing.

    Methods

    View Source

    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
    Microsoft.AspNetCore.Builder.IApplicationBuilder app

    The application.

    View Source

    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
    Microsoft.AspNetCore.Builder.IApplicationBuilder app

    The application.

    View Source

    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
    Microsoft.AspNetCore.Builder.IApplicationBuilder app

    The application.

    View Source

    OnPrePipeline(IApplicationBuilder)

    Executes before any default Umbraco middlewares are registered.

    Declaration
    public void OnPrePipeline(IApplicationBuilder app)
    Parameters
    Type Name Description
    Microsoft.AspNetCore.Builder.IApplicationBuilder app

    The application.

    View Source

    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
    Microsoft.AspNetCore.Builder.IApplicationBuilder app

    The application.

    • Improve this Doc
    • View Source
    In This Article
    • Constructors
      • UmbracoPipelineFilter(String)
      • UmbracoPipelineFilter(String, Nullable<Action<IApplicationBuilder>>, Nullable<Action<IApplicationBuilder>>, Nullable<Action<IApplicationBuilder>>, Nullable<Action<IApplicationBuilder>>, Nullable<Action<IApplicationBuilder>>)
    • Properties
      • Endpoints
      • Name
      • PostPipeline
      • PostRouting
      • PrePipeline
      • PreRouting
    • Methods
      • OnEndpoints(IApplicationBuilder)
      • OnPostPipeline(IApplicationBuilder)
      • OnPostRouting(IApplicationBuilder)
      • OnPrePipeline(IApplicationBuilder)
      • OnPreRouting(IApplicationBuilder)
    Back to top Copyright © 2016-present Umbraco
    Generated by DocFX