Class EndpointRouteBuilderExtensions

Inheritance

object

Namespace: Umbraco.Extensions

Assembly: Umbraco.Web.Common.dll

Syntax

public static class EndpointRouteBuilderExtensions

Methods

View Source

MapUmbracoApiRoute(IEndpointRouteBuilder, Type, string, string?, bool, 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
IEndpointRouteBuilder	endpoints
Type	controllerType
string	rootSegment
string	areaName
bool	isBackOffice
string	defaultAction
object	constraints

View Source

MapUmbracoApiRoute<T>(IEndpointRouteBuilder, string, string, bool, 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
IEndpointRouteBuilder	endpoints
string	rootSegment
string	areaName
bool	isBackOffice
string	defaultAction
object	constraints

Type Parameters

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

View Source

MapUmbracoRoute(IEndpointRouteBuilder, Type, string, string?, string?, string, bool, 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
IEndpointRouteBuilder	endpoints
Type	controllerType
string	rootSegment
string	areaName
string	prefixPathSegment
string	defaultAction
bool	includeControllerNameInRoute
object	constraints

View Source

MapUmbracoRoute<T>(IEndpointRouteBuilder, string, string, string?, string, bool, 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
IEndpointRouteBuilder	endpoints
string	rootSegment
string	areaName
string	prefixPathSegment
string	defaultAction
bool	includeControllerNameInRoute
object	constraints

Type Parameters

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

View Source

MapUmbracoSurfaceRoute(IEndpointRouteBuilder, Type, string, string?, string, bool, 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
IEndpointRouteBuilder	endpoints
Type	controllerType
string	rootSegment
string	areaName
string	defaultAction
bool	includeControllerNameInRoute
object	constraints