View Source

Class UmbracoRouteValueTransformer

The route value transformer for Umbraco front-end routes

Inheritance

System.Object

Microsoft.AspNetCore.Mvc.Routing.DynamicRouteValueTransformer

Namespace: Umbraco.Cms.Web.Website.Routing

Assembly: Umbraco.Web.Website.dll

Syntax

public class UmbracoRouteValueTransformer : DynamicRouteValueTransformer

Remarks

NOTE: In aspnet 5 DynamicRouteValueTransformer has been improved, see https://github.com/dotnet/aspnetcore/issues/21471 It seems as though with the "State" parameter we could more easily assign the IPublishedRequest or IPublishedContent or UmbracoContext more easily that way. In the meantime we will rely on assigning the IPublishedRequest to the route values along with the IPublishedContent to the umbraco context have created a GH discussion here https://github.com/dotnet/aspnetcore/discussions/28562 we'll see if anyone responds

Constructors

UmbracoRouteValueTransformer(ILogger<UmbracoRouteValueTransformer>, IUmbracoContextAccessor, IPublishedRouter, IRuntimeState, IUmbracoRouteValuesFactory, IRoutableDocumentFilter, IDataProtectionProvider, IControllerActionSearcher, IPublicAccessRequestHandler)

Declaration

public UmbracoRouteValueTransformer(ILogger<UmbracoRouteValueTransformer> logger, IUmbracoContextAccessor umbracoContextAccessor, IPublishedRouter publishedRouter, IRuntimeState runtime, IUmbracoRouteValuesFactory routeValuesFactory, IRoutableDocumentFilter routableDocumentFilter, IDataProtectionProvider dataProtectionProvider, IControllerActionSearcher controllerActionSearcher, IPublicAccessRequestHandler publicAccessRequestHandler)

Parameters

Type	Name	Description
Microsoft.Extensions.Logging.ILogger<UmbracoRouteValueTransformer>	logger
IUmbracoContextAccessor	umbracoContextAccessor
IPublishedRouter	publishedRouter
IRuntimeState	runtime
IUmbracoRouteValuesFactory	routeValuesFactory
IRoutableDocumentFilter	routableDocumentFilter
Microsoft.AspNetCore.DataProtection.IDataProtectionProvider	dataProtectionProvider
IControllerActionSearcher	controllerActionSearcher
IPublicAccessRequestHandler	publicAccessRequestHandler

UmbracoRouteValueTransformer(ILogger<UmbracoRouteValueTransformer>, IUmbracoContextAccessor, IPublishedRouter, IRuntimeState, IUmbracoRouteValuesFactory, IRoutableDocumentFilter, IDataProtectionProvider, IControllerActionSearcher, IPublicAccessRequestHandler, IUmbracoVirtualPageRoute)

Declaration

public UmbracoRouteValueTransformer(ILogger<UmbracoRouteValueTransformer> logger, IUmbracoContextAccessor umbracoContextAccessor, IPublishedRouter publishedRouter, IRuntimeState runtime, IUmbracoRouteValuesFactory routeValuesFactory, IRoutableDocumentFilter routableDocumentFilter, IDataProtectionProvider dataProtectionProvider, IControllerActionSearcher controllerActionSearcher, IPublicAccessRequestHandler publicAccessRequestHandler, IUmbracoVirtualPageRoute umbracoVirtualPageRoute)

Parameters

Type	Name	Description
Microsoft.Extensions.Logging.ILogger<UmbracoRouteValueTransformer>	logger
IUmbracoContextAccessor	umbracoContextAccessor
IPublishedRouter	publishedRouter
IRuntimeState	runtime
IUmbracoRouteValuesFactory	routeValuesFactory
IRoutableDocumentFilter	routableDocumentFilter
Microsoft.AspNetCore.DataProtection.IDataProtectionProvider	dataProtectionProvider
IControllerActionSearcher	controllerActionSearcher
IPublicAccessRequestHandler	publicAccessRequestHandler
IUmbracoVirtualPageRoute	umbracoVirtualPageRoute

UmbracoRouteValueTransformer(ILogger<UmbracoRouteValueTransformer>, IUmbracoContextAccessor, IPublishedRouter, IRuntimeState, IUmbracoRouteValuesFactory, IRoutableDocumentFilter, IDataProtectionProvider, IControllerActionSearcher, IPublicAccessRequestHandler, IUmbracoVirtualPageRoute, IOptionsMonitor<GlobalSettings>)

Initializes a new instance of the UmbracoRouteValueTransformer class.

Declaration

public UmbracoRouteValueTransformer(ILogger<UmbracoRouteValueTransformer> logger, IUmbracoContextAccessor umbracoContextAccessor, IPublishedRouter publishedRouter, IRuntimeState runtime, IUmbracoRouteValuesFactory routeValuesFactory, IRoutableDocumentFilter routableDocumentFilter, IDataProtectionProvider dataProtectionProvider, IControllerActionSearcher controllerActionSearcher, IPublicAccessRequestHandler publicAccessRequestHandler, IUmbracoVirtualPageRoute umbracoVirtualPageRoute, IOptionsMonitor<GlobalSettings> globalSettings)

Parameters

Type	Name	Description
Microsoft.Extensions.Logging.ILogger<UmbracoRouteValueTransformer>	logger
IUmbracoContextAccessor	umbracoContextAccessor
IPublishedRouter	publishedRouter
IRuntimeState	runtime
IUmbracoRouteValuesFactory	routeValuesFactory
IRoutableDocumentFilter	routableDocumentFilter
Microsoft.AspNetCore.DataProtection.IDataProtectionProvider	dataProtectionProvider
IControllerActionSearcher	controllerActionSearcher
IPublicAccessRequestHandler	publicAccessRequestHandler
IUmbracoVirtualPageRoute	umbracoVirtualPageRoute
Microsoft.Extensions.Options.IOptionsMonitor<GlobalSettings>	globalSettings

UmbracoRouteValueTransformer(ILogger<UmbracoRouteValueTransformer>, IUmbracoContextAccessor, IPublishedRouter, IOptions<GlobalSettings>, IHostingEnvironment, IRuntimeState, IUmbracoRouteValuesFactory, IRoutableDocumentFilter, IDataProtectionProvider, IControllerActionSearcher, IEventAggregator, IPublicAccessRequestHandler)

Declaration

public UmbracoRouteValueTransformer(ILogger<UmbracoRouteValueTransformer> logger, IUmbracoContextAccessor umbracoContextAccessor, IPublishedRouter publishedRouter, IOptions<GlobalSettings> globalSettings, IHostingEnvironment hostingEnvironment, IRuntimeState runtime, IUmbracoRouteValuesFactory routeValuesFactory, IRoutableDocumentFilter routableDocumentFilter, IDataProtectionProvider dataProtectionProvider, IControllerActionSearcher controllerActionSearcher, IEventAggregator eventAggregator, IPublicAccessRequestHandler publicAccessRequestHandler)

Parameters

Type	Name	Description
Microsoft.Extensions.Logging.ILogger<UmbracoRouteValueTransformer>	logger
IUmbracoContextAccessor	umbracoContextAccessor
IPublishedRouter	publishedRouter
Microsoft.Extensions.Options.IOptions<GlobalSettings>	globalSettings
IHostingEnvironment	hostingEnvironment
IRuntimeState	runtime
IUmbracoRouteValuesFactory	routeValuesFactory
IRoutableDocumentFilter	routableDocumentFilter
Microsoft.AspNetCore.DataProtection.IDataProtectionProvider	dataProtectionProvider
IControllerActionSearcher	controllerActionSearcher
IEventAggregator	eventAggregator
IPublicAccessRequestHandler	publicAccessRequestHandler

Methods

TransformAsync(HttpContext, RouteValueDictionary)

Declaration

public override async ValueTask<RouteValueDictionary> TransformAsync(HttpContext httpContext, RouteValueDictionary values)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Http.HttpContext	httpContext
Microsoft.AspNetCore.Routing.RouteValueDictionary	values

Returns

Type	Description
ValueTask<Microsoft.AspNetCore.Routing.RouteValueDictionary>