ApiExplorer.ShouldExploreAction Method (String, HttpActionDescriptor, IHttpRoute)

 

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

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 Overridable Function ShouldExploreAction (
    actionVariableValue As String,
    actionDescriptor As HttpActionDescriptor,
    route As IHttpRoute
) As 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

ApiExplorer Class
System.Web.Http.Description Namespace

Return to top