ApiExplorer.ShouldExploreAction Method

Determines whether the action should be considered for ApiDescriptions generation. Called when initializing the ApiDescriptions.

Namespace:  System.Web.Http.Description
Assembly:  System.Web.Http (in System.Web.Http.dll)

Syntax

'Declaration
Public Overridable Function ShouldExploreAction ( _
    actionVariableValue As String, _
    actionDescriptor As HttpActionDescriptor, _
    route As IHttpRoute _
) As Boolean
'Usage
Dim instance As ApiExplorer 
Dim actionVariableValue As String 
Dim actionDescriptor As HttpActionDescriptor 
Dim route As IHttpRoute 
Dim returnValue As Boolean 

returnValue = instance.ShouldExploreAction(actionVariableValue, _
    actionDescriptor, route)

public virtual bool ShouldExploreAction(
    string actionVariableValue,
    HttpActionDescriptor actionDescriptor,
    IHttpRoute route
)

public:
virtual bool ShouldExploreAction(
    String^ actionVariableValue, 
    HttpActionDescriptor^ actionDescriptor, 
    IHttpRoute^ route
)

abstract ShouldExploreAction : 
        actionVariableValue:string * 
        actionDescriptor:HttpActionDescriptor * 
        route:IHttpRoute -> bool  
override ShouldExploreAction : 
        actionVariableValue:string * 
        actionDescriptor:HttpActionDescriptor * 
        route:IHttpRoute -> bool

public function ShouldExploreAction(
    actionVariableValue : String, 
    actionDescriptor : HttpActionDescriptor, 
    route : IHttpRoute
) : boolean

Parameters

• actionVariableValue
  Type: System.String

  The action variable value from the route.

• actionDescriptor
  Type: System.Web.Http.Controllers.HttpActionDescriptor

  The action descriptor.

• route
  Type: System.Web.Http.Routing.IHttpRoute

  The route.

Return Value

Type: System.Boolean
true if the action should be considered for ApiDescriptions generation, false otherwise.

See Also

Reference

ApiExplorer Class

System.Web.Http.Description Namespace