IRouteBuilder Interface

Definition

Namespace:

Microsoft.AspNetCore.Routing

Assembly:

Microsoft.AspNetCore.Routing.dll

Package:

Microsoft.AspNetCore.App.Ref v8.0.0

Source:

IRouteBuilder.cs

Defines a contract for a route builder in an application. A route builder specifies the routes for an application.

public interface class IRouteBuilder

public interface IRouteBuilder

type IRouteBuilder = interface

Public Interface IRouteBuilder

Derived

Microsoft.AspNetCore.Routing.RouteBuilder

Properties

ApplicationBuilder	Gets the IApplicationBuilder.
DefaultHandler	Gets or sets the default IRouter that is used as a handler if an IRouter is added to the list of routes but does not specify its own.
Routes	Gets the routes configured in the builder.
ServiceProvider	Gets the sets the IServiceProvider used to resolve services for routes.

Methods

Build()

Builds an IRouter that routes the routes specified in the Routes property.

Extension Methods

MapRoute(IRouteBuilder, String, String, Object, Object, Object)	Adds a route to the IRouteBuilder with the specified name, template, default values, and data tokens.
MapRoute(IRouteBuilder, String, String, Object, Object)	Adds a route to the IRouteBuilder with the specified name, template, default values, and constraints.
MapRoute(IRouteBuilder, String, String, Object)	Adds a route to the IRouteBuilder with the specified name, template, and default values.
MapRoute(IRouteBuilder, String, String)	Adds a route to the IRouteBuilder with the specified name and template.
MapAreaRoute(IRouteBuilder, String, String, String, Object, Object, Object)	Adds a route to the IRouteBuilder with the given MVC area with the specified name, areaName, template, defaults, constraints, and dataTokens.
MapAreaRoute(IRouteBuilder, String, String, String, Object, Object)	Adds a route to the IRouteBuilder with the given MVC area with the specified name, areaName, template, defaults, and constraints.
MapAreaRoute(IRouteBuilder, String, String, String, Object)	Adds a route to the IRouteBuilder with the given MVC area with the specified name, areaName, template, and defaults.
MapAreaRoute(IRouteBuilder, String, String, String)	Adds a route to the IRouteBuilder with the given MVC area with the specified name, areaName and template.
MapDelete(IRouteBuilder, String, RequestDelegate)	Adds a route to the IRouteBuilder that only matches HTTP DELETE requests for the given template, and handler.
MapDelete(IRouteBuilder, String, Func<HttpRequest,HttpResponse,RouteData,Task>)	Adds a route to the IRouteBuilder that only matches HTTP DELETE requests for the given template, and handler.
MapGet(IRouteBuilder, String, RequestDelegate)	Adds a route to the IRouteBuilder that only matches HTTP GET requests for the given template, and handler.
MapGet(IRouteBuilder, String, Func<HttpRequest,HttpResponse,RouteData,Task>)	Adds a route to the IRouteBuilder that only matches HTTP GET requests for the given template, and handler.
MapMiddlewareDelete(IRouteBuilder, String, Action<IApplicationBuilder>)	Adds a route to the IRouteBuilder that only matches HTTP DELETE requests for the given template, and action.
MapMiddlewareGet(IRouteBuilder, String, Action<IApplicationBuilder>)	Adds a route to the IRouteBuilder that only matches HTTP GET requests for the given template, and action.
MapMiddlewarePost(IRouteBuilder, String, Action<IApplicationBuilder>)	Adds a route to the IRouteBuilder that only matches HTTP POST requests for the given template, and action.
MapMiddlewarePut(IRouteBuilder, String, Action<IApplicationBuilder>)	Adds a route to the IRouteBuilder that only matches HTTP PUT requests for the given template, and action.
MapMiddlewareRoute(IRouteBuilder, String, Action<IApplicationBuilder>)	Adds a route to the IRouteBuilder for the given template, and action.
MapMiddlewareVerb(IRouteBuilder, String, String, Action<IApplicationBuilder>)	Adds a route to the IRouteBuilder that only matches HTTP requests for the given verb, template, and action.
MapPost(IRouteBuilder, String, RequestDelegate)	Adds a route to the IRouteBuilder that only matches HTTP POST requests for the given template, and handler.
MapPost(IRouteBuilder, String, Func<HttpRequest,HttpResponse,RouteData,Task>)	Adds a route to the IRouteBuilder that only matches HTTP POST requests for the given template, and handler.
MapPut(IRouteBuilder, String, RequestDelegate)	Adds a route to the IRouteBuilder that only matches HTTP PUT requests for the given template, and handler.
MapPut(IRouteBuilder, String, Func<HttpRequest,HttpResponse,RouteData,Task>)	Adds a route to the IRouteBuilder that only matches HTTP PUT requests for the given template, and handler.
MapRoute(IRouteBuilder, String, RequestDelegate)	Adds a route to the IRouteBuilder for the given template, and handler.
MapVerb(IRouteBuilder, String, String, RequestDelegate)	Adds a route to the IRouteBuilder that only matches HTTP requests for the given verb, template, and handler.
MapVerb(IRouteBuilder, String, String, Func<HttpRequest,HttpResponse,RouteData,Task>)	Adds a route to the IRouteBuilder that only matches HTTP requests for the given verb, template, and handler.