AttributeRoutingConvention Class

Reference

Definition

Namespace:: Microsoft.AspNet.OData.Routing.Conventions

Assembly:: Microsoft.AspNet.OData.dll

Assembly:: Microsoft.AspNetCore.OData.dll

Package:: Microsoft.AspNet.OData v7.5.8

Package:: Microsoft.AspNetCore.OData v7.5.8

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents a routing convention that looks for ODataRouteAttributes to match an ODataPath to a controller and an action.

public class AttributeRoutingConvention : Microsoft.AspNet.OData.Routing.Conventions.IODataRoutingConvention

type AttributeRoutingConvention = class
    interface IODataRoutingConvention

Public Class AttributeRoutingConvention
Implements IODataRoutingConvention

Inheritance: Object
AttributeRoutingConvention

Implements: IODataRoutingConvention

Constructors

AttributeRoutingConvention(String, HttpConfiguration, IODataPathTemplateHandler)	Initializes a new instance of the AttributeRoutingConvention class.
AttributeRoutingConvention(String, HttpConfiguration)	Initializes a new instance of the AttributeRoutingConvention class.
AttributeRoutingConvention(String, IEnumerable<HttpControllerDescriptor>, IODataPathTemplateHandler)	Initializes a new instance of the AttributeRoutingConvention class.
AttributeRoutingConvention(String, IEnumerable<HttpControllerDescriptor>)	Initializes a new instance of the AttributeRoutingConvention class.
AttributeRoutingConvention(String, IServiceProvider, IODataPathTemplateHandler)	Initializes a new instance of the AttributeRoutingConvention class.

Properties

ODataPathTemplateHandler

Gets the IODataPathTemplateHandler to be used for parsing the route templates.

Methods

SelectAction(ODataPath, HttpControllerContext, ILookup<String,HttpActionDescriptor>)	Selects the action for OData requests.
SelectAction(RouteContext)	Selects the controller and action for OData requests.
SelectController(ODataPath, HttpRequestMessage)	Selects the controller for OData requests.
ShouldMapController(ControllerActionDescriptor)	Specifies whether OData route attributes on this controller should be mapped. This method will execute before the derived type's instance constructor executes. Derived types must be aware of this and should plan accordingly. For example, the logic in ShouldMapController() should be simple enough so as not to depend on the "this" pointer referencing a fully constructed object.
ShouldMapController(HttpControllerDescriptor)	Specifies whether OData route attributes on this controller should be mapped. This method will execute before the derived type's instance constructor executes. Derived types must be aware of this and should plan accordingly. For example, the logic in ShouldMapController() should be simple enough so as not to depend on the "this" pointer referencing a fully constructed object.

Applies to

Jaa