Search Results for

    Show / Hide Table of Contents
    View Source

    Class UmbracoApplicationBuilder

    A builder used to enable middleware and endpoints required for Umbraco to operate.

    Inheritance
    System.Object
    Namespace: Umbraco.Cms.Web.Common.ApplicationBuilder
    Assembly: Umbraco.Web.Common.dll
    Syntax
    public class UmbracoApplicationBuilder : IUmbracoApplicationBuilder, IUmbracoEndpointBuilder, IUmbracoApplicationBuilderContext, IUmbracoApplicationBuilderServices
    Remarks

    This helps to ensure that everything is registered in the correct order.

    Constructors

    View Source

    UmbracoApplicationBuilder(IApplicationBuilder)

    Declaration
    public UmbracoApplicationBuilder(IApplicationBuilder appBuilder)
    Parameters
    Type Name Description
    Microsoft.AspNetCore.Builder.IApplicationBuilder appBuilder

    Properties

    View Source

    AppBuilder

    Declaration
    public IApplicationBuilder AppBuilder { get; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Builder.IApplicationBuilder
    View Source

    ApplicationServices

    Declaration
    public IServiceProvider ApplicationServices { get; }
    Property Value
    Type Description
    IServiceProvider
    View Source

    RuntimeState

    Declaration
    public IRuntimeState RuntimeState { get; }
    Property Value
    Type Description
    IRuntimeState

    Methods

    View Source

    RegisterDefaultRequiredMiddleware()

    Registers the default required middleware to run Umbraco.

    Declaration
    public void RegisterDefaultRequiredMiddleware()
    View Source

    RunPostPipeline()

    Declaration
    public void RunPostPipeline()
    View Source

    RunPostRouting()

    Declaration
    public void RunPostRouting()
    View Source

    RunPrePipeline()

    Declaration
    public void RunPrePipeline()
    View Source

    RunPreRouting()

    Declaration
    public void RunPreRouting()
    View Source

    UseUmbracoCoreMiddleware()

    Declaration
    public void UseUmbracoCoreMiddleware()
    View Source

    WithCustomMiddleware(Action<IUmbracoApplicationBuilderContext>)

    EXPERT call to replace the middlewares that Umbraco installs by default with a completely custom pipeline.

    Declaration
    public IUmbracoEndpointBuilder WithCustomMiddleware(Action<IUmbracoApplicationBuilderContext> configureUmbracoMiddleware)
    Parameters
    Type Name Description
    Action<IUmbracoApplicationBuilderContext> configureUmbracoMiddleware
    Returns
    Type Description
    IUmbracoEndpointBuilder
    View Source

    WithEndpoints(Action<IUmbracoEndpointBuilderContext>)

    Final call during app building to configure endpoints

    Declaration
    public void WithEndpoints(Action<IUmbracoEndpointBuilderContext> configureUmbraco)
    Parameters
    Type Name Description
    Action<IUmbracoEndpointBuilderContext> configureUmbraco
    View Source

    WithMiddleware(Action<IUmbracoApplicationBuilderContext>)

    Called to include default middleware to run umbraco.

    Declaration
    public IUmbracoEndpointBuilder WithMiddleware(Action<IUmbracoApplicationBuilderContext> configureUmbracoMiddleware)
    Parameters
    Type Name Description
    Action<IUmbracoApplicationBuilderContext> configureUmbracoMiddleware
    Returns
    Type Description
    IUmbracoEndpointBuilder
    • Improve this Doc
    • View Source
    In This Article
    • Constructors
      • UmbracoApplicationBuilder(IApplicationBuilder)
    • Properties
      • AppBuilder
      • ApplicationServices
      • RuntimeState
    • Methods
      • RegisterDefaultRequiredMiddleware()
      • RunPostPipeline()
      • RunPostRouting()
      • RunPrePipeline()
      • RunPreRouting()
      • UseUmbracoCoreMiddleware()
      • WithCustomMiddleware(Action<IUmbracoApplicationBuilderContext>)
      • WithEndpoints(Action<IUmbracoEndpointBuilderContext>)
      • WithMiddleware(Action<IUmbracoApplicationBuilderContext>)
    Back to top Copyright © 2016-present Umbraco
    Generated by DocFX