31 lines
1.5 KiB
C#
31 lines
1.5 KiB
C#
// Copyright (c) .NET Foundation. All rights reserved.
|
|
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
|
|
|
|
using System.Collections.Generic;
|
|
using Microsoft.AspNet.Http;
|
|
|
|
namespace Microsoft.AspNet.Routing
|
|
{
|
|
/// <summary>
|
|
/// Defines the contract that a class must implement in order to check whether a URL parameter value is valid for a constraint.
|
|
/// </summary>
|
|
public interface IRouteConstraint
|
|
{
|
|
/// <summary>
|
|
/// Determines whether the URL parameter contains a valid value for this constraint.
|
|
/// </summary>
|
|
/// <param name="httpContext">An object that encapsulates information about the HTTP request.</param>
|
|
/// <param name="route">The router that this constraint belongs to.</param>
|
|
/// <param name="routeKey">The name of the parameter that is being checked.</param>
|
|
/// <param name="values">A dictionary that contains the parameters for the URL.</param>
|
|
/// <param name="routeDirection">An object that indicates whether the constraint check is being performed when an incoming request is being handled or when a URL is being generated.</param>
|
|
/// <returns><c>true</c> if the URL parameter contains a valid value; otherwise, <c>false</c>.</returns>
|
|
bool Match(
|
|
HttpContext httpContext,
|
|
IRouter route,
|
|
string routeKey,
|
|
IDictionary<string, object> values,
|
|
RouteDirection routeDirection);
|
|
}
|
|
}
|