Class QueryStringParameterScopeExpression

Namespace

JsonApiDotNetCore.Queries.Expressions

Assembly

JsonApiDotNetCore.dll

Represents the relationship scope of a query string parameter, resulting from text such as: ?sort[articles] , or: ?filter[author.articles.comments] .

[PublicAPI]
public class QueryStringParameterScopeExpression : QueryExpression

Inheritance

object

QueryExpression

QueryStringParameterScopeExpression

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Constructors

QueryStringParameterScopeExpression(LiteralConstantExpression, IncludeExpression?)

public QueryStringParameterScopeExpression(LiteralConstantExpression parameterName, IncludeExpression? scope)

Parameters

parameterName LiteralConstantExpression

scope IncludeExpression

Properties

ParameterName

The name of the query string parameter, without its surrounding brackets.

public LiteralConstantExpression ParameterName { get; }

Property Value

LiteralConstantExpression

Scope

The scope this parameter value applies to, or null for the URL endpoint scope. Chain format for the filter/sort parameters: an optional list of relationships, followed by a to-many relationship.

public IncludeExpression? Scope { get; }

Property Value

IncludeExpression

Methods

Accept<TArgument, TResult>(QueryExpressionVisitor<TArgument, TResult>, TArgument)

public override TResult Accept<TArgument, TResult>(QueryExpressionVisitor<TArgument, TResult> visitor, TArgument argument)

Parameters

visitor QueryExpressionVisitor<TArgument, TResult>

argument TArgument

Returns

TResult

Type Parameters

TArgument

TResult

Equals(object?)

Determines whether the specified object is equal to the current object.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current object.

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

ToFullString()

public override string ToFullString()

Returns

string

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.