Class UmbracoApplicationBuilder

Namespace

Umbraco.Cms.Web.Common.ApplicationBuilder

Assembly

Umbraco.Web.Common.dll

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

public class UmbracoApplicationBuilder : IUmbracoApplicationBuilder, IUmbracoEndpointBuilder, IUmbracoApplicationBuilderContext, IUmbracoApplicationBuilderServices

Inheritance

object

UmbracoApplicationBuilder

Implements

IUmbracoApplicationBuilder

IUmbracoEndpointBuilder

IUmbracoApplicationBuilderContext

IUmbracoApplicationBuilderServices

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

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

Constructors

UmbracoApplicationBuilder(IApplicationBuilder)

public UmbracoApplicationBuilder(IApplicationBuilder appBuilder)

Parameters

appBuilder IApplicationBuilder

Properties

AppBuilder

public IApplicationBuilder AppBuilder { get; }

Property Value

IApplicationBuilder

ApplicationServices

public IServiceProvider ApplicationServices { get; }

Property Value

IServiceProvider

RuntimeState

public IRuntimeState RuntimeState { get; }

Property Value

IRuntimeState

Methods

RegisterDefaultRequiredMiddleware()

Registers the default required middleware to run Umbraco.

public void RegisterDefaultRequiredMiddleware()

RunPostPipeline()

Manually runs the IUmbracoPipelineFilter post pipeline filters.

public void RunPostPipeline()

RunPostRouting()

Manually runs the IUmbracoPipelineFilter post routing filters.

public void RunPostRouting()

RunPrePipeline()

Manually runs the IUmbracoPipelineFilter pre pipeline filters.

public void RunPrePipeline()

RunPreRouting()

Manually runs the IUmbracoPipelineFilter pre routing filters.

public void RunPreRouting()

UseUmbracoCoreMiddleware()

Called to include the core Umbraco middlewares.

public void UseUmbracoCoreMiddleware()

WithCustomMiddleware(Action<IUmbracoApplicationBuilderContext>)

public IUmbracoEndpointBuilder WithCustomMiddleware(Action<IUmbracoApplicationBuilderContext> configureUmbracoMiddleware)

Parameters

configureUmbracoMiddleware Action<IUmbracoApplicationBuilderContext>

Returns

IUmbracoEndpointBuilder

WithEndpoints(Action<IUmbracoEndpointBuilderContext>)

public void WithEndpoints(Action<IUmbracoEndpointBuilderContext> configureUmbraco)

Parameters

configureUmbraco Action<IUmbracoEndpointBuilderContext>

WithMiddleware(Action<IUmbracoApplicationBuilderContext>)

public IUmbracoEndpointBuilder WithMiddleware(Action<IUmbracoApplicationBuilderContext> configureUmbracoMiddleware)

Parameters

configureUmbracoMiddleware Action<IUmbracoApplicationBuilderContext>

Returns

IUmbracoEndpointBuilder