IActionSelector.SelectBestCandidate Method

Reference

Definition

Namespace:: Microsoft.AspNetCore.Mvc.Infrastructure

Assembly:: Microsoft.AspNetCore.Mvc.Core.dll

Package:: Microsoft.AspNetCore.Mvc.Core v1.0.0

Package:: Microsoft.AspNetCore.Mvc.Core v1.1.0

Package:: Microsoft.AspNetCore.Mvc.Core v2.0.0

Package:: Microsoft.AspNetCore.Mvc.Core v2.1.0

Package:: Microsoft.AspNetCore.Mvc.Core v2.2.0

Package:: Microsoft.AspNetCore.App.Ref v3.0.1

Package:: Microsoft.AspNetCore.App.Ref v3.1.10

Package:: Microsoft.AspNetCore.App.Ref v5.0.0

Package:: Microsoft.AspNetCore.App.Ref v6.0.6

Package:: Microsoft.AspNetCore.App.Ref v7.0.5

Package:: Microsoft.AspNetCore.App.Ref v8.0.0

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.

Selects the best ActionDescriptor candidate from candidates for the current request associated with context.

public:
 Microsoft::AspNetCore::Mvc::Abstractions::ActionDescriptor ^ SelectBestCandidate(Microsoft::AspNetCore::Routing::RouteContext ^ context, System::Collections::Generic::IReadOnlyList<Microsoft::AspNetCore::Mvc::Abstractions::ActionDescriptor ^> ^ candidates);

public Microsoft.AspNetCore.Mvc.Abstractions.ActionDescriptor SelectBestCandidate (Microsoft.AspNetCore.Routing.RouteContext context, System.Collections.Generic.IReadOnlyList<Microsoft.AspNetCore.Mvc.Abstractions.ActionDescriptor> candidates);

public Microsoft.AspNetCore.Mvc.Abstractions.ActionDescriptor? SelectBestCandidate (Microsoft.AspNetCore.Routing.RouteContext context, System.Collections.Generic.IReadOnlyList<Microsoft.AspNetCore.Mvc.Abstractions.ActionDescriptor> candidates);

abstract member SelectBestCandidate : Microsoft.AspNetCore.Routing.RouteContext * System.Collections.Generic.IReadOnlyList<Microsoft.AspNetCore.Mvc.Abstractions.ActionDescriptor> -> Microsoft.AspNetCore.Mvc.Abstractions.ActionDescriptor

Public Function SelectBestCandidate (context As RouteContext, candidates As IReadOnlyList(Of ActionDescriptor)) As ActionDescriptor

Parameters

context: RouteContext

The RouteContext associated with the current request.

candidates: IReadOnlyList<ActionDescriptor>

The set of ActionDescriptor candidates.

Returns

ActionDescriptor

The best ActionDescriptor candidate for the current request or null.

Exceptions

Microsoft.AspNetCore.Mvc.Internal.AmbiguousActionException

Thrown when action selection results in an ambiguity.

AmbiguousActionException

Thrown when action selection results in an ambiguity.

Remarks

Invokes action constraints associated with the candidates.

Used by conventional routing after calling SelectCandidates(RouteContext) to apply action constraints and disambiguate between multiple candidates.

Used by attribute routing to apply action constraints and disambiguate between multiple candidates.

Applies to