View Source

Class EndpointRouteBuilderExtensions

Inheritance

System.Object

Namespace: Umbraco.Extensions

Assembly: Umbraco.Web.Common.dll

Syntax

public static class EndpointRouteBuilderExtensions

Methods

MapUmbracoApiRoute(IEndpointRouteBuilder, Type, String, String, Boolean, String, Object)

Used to map controllers as Umbraco API routes consistently

Declaration

public static void MapUmbracoApiRoute(this IEndpointRouteBuilder endpoints, Type controllerType, string rootSegment, string areaName, bool isBackOffice, string defaultAction = "Index", object constraints = null)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Routing.IEndpointRouteBuilder	endpoints
Type	controllerType
System.String	rootSegment
System.String	areaName
System.Boolean	isBackOffice
System.String	defaultAction
System.Object	constraints

MapUmbracoApiRoute<T>(IEndpointRouteBuilder, String, String, Boolean, String, Object)

Used to map controllers as Umbraco API routes consistently

Declaration

public static void MapUmbracoApiRoute<T>(this IEndpointRouteBuilder endpoints, string rootSegment, string areaName, bool isBackOffice, string defaultAction = "Index", object constraints = null)
    where T : ControllerBase

Parameters

Type	Name	Description
Microsoft.AspNetCore.Routing.IEndpointRouteBuilder	endpoints
System.String	rootSegment
System.String	areaName
System.Boolean	isBackOffice
System.String	defaultAction
System.Object	constraints

Type Parameters

Name	Description
T	The Microsoft.AspNetCore.Mvc.ControllerBase type to route

MapUmbracoRoute(IEndpointRouteBuilder, Type, String, String, String, String, Boolean, Object)

Used to map Umbraco controllers consistently

Declaration

public static void MapUmbracoRoute(this IEndpointRouteBuilder endpoints, Type controllerType, string rootSegment, string areaName, string prefixPathSegment, string defaultAction = "Index", bool includeControllerNameInRoute = true, object constraints = null)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Routing.IEndpointRouteBuilder	endpoints
Type	controllerType
System.String	rootSegment
System.String	areaName
System.String	prefixPathSegment
System.String	defaultAction
System.Boolean	includeControllerNameInRoute
System.Object	constraints

MapUmbracoRoute<T>(IEndpointRouteBuilder, String, String, String, String, Boolean, Object)

Used to map Umbraco controllers consistently

Declaration

public static void MapUmbracoRoute<T>(this IEndpointRouteBuilder endpoints, string rootSegment, string areaName, string prefixPathSegment, string defaultAction = "Index", bool includeControllerNameInRoute = true, object constraints = null)
    where T : ControllerBase

Parameters

Type	Name	Description
Microsoft.AspNetCore.Routing.IEndpointRouteBuilder	endpoints
System.String	rootSegment
System.String	areaName
System.String	prefixPathSegment
System.String	defaultAction
System.Boolean	includeControllerNameInRoute
System.Object	constraints

Type Parameters

Name	Description
T	The Microsoft.AspNetCore.Mvc.ControllerBase type to route

MapUmbracoSurfaceRoute(IEndpointRouteBuilder, Type, String, String, String, Boolean, Object)

Declaration

public static void MapUmbracoSurfaceRoute(this IEndpointRouteBuilder endpoints, Type controllerType, string rootSegment, string areaName, string defaultAction = "Index", bool includeControllerNameInRoute = true, object constraints = null)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Routing.IEndpointRouteBuilder	endpoints
Type	controllerType
System.String	rootSegment
System.String	areaName
System.String	defaultAction
System.Boolean	includeControllerNameInRoute
System.Object	constraints