Table of Contents

Class IncludeParser

Namespace
JsonApiDotNetCore.Queries.Parsing
Assembly
JsonApiDotNetCore.dll

Parses the JSON:API 'include' query string parameter value.

[PublicAPI]
public class IncludeParser : QueryExpressionParser, IIncludeParser
Inheritance
IncludeParser
Implements
Inherited Members

Constructors

IncludeParser(IJsonApiOptions)

public IncludeParser(IJsonApiOptions options)

Parameters

options IJsonApiOptions

Methods

Parse(string, ResourceType)

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

public IncludeExpression Parse(string source, ResourceType resourceType)

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.

Returns

IncludeExpression

ParseInclude(string, ResourceType)

protected virtual IncludeExpression ParseInclude(string source, ResourceType resourceType)

Parameters

source string
resourceType ResourceType

Returns

IncludeExpression