Interface IQueryStringParameterScopeParser

Namespace

JsonApiDotNetCore.Queries.Parsing

Assembly

JsonApiDotNetCore.dll

Parses the JSON:API 'sort' and 'filter' query string parameter names, which contain a resource field chain that indicates the scope its query string parameter value applies to.

public interface IQueryStringParameterScopeParser

Methods

Parse(string, ResourceType, FieldChainPattern, FieldChainPatternMatchOptions)

Parses the specified source into a QueryStringParameterScopeExpression. Throws a QueryParseException if the input is invalid.

QueryStringParameterScopeExpression Parse(string source, ResourceType resourceType, FieldChainPattern pattern, FieldChainPatternMatchOptions options)

Parameters

source string

The source text to read from.

resourceType ResourceType

The resource type used to lookup JSON:API fields that are referenced in source.

pattern FieldChainPattern

The pattern that the field chain in source must match.

options FieldChainPatternMatchOptions

The match options for pattern.

Returns

QueryStringParameterScopeExpression