Interface IQueryStringParameterReader

Namespace

JsonApiDotNetCore.QueryStrings

Assembly

JsonApiDotNetCore.dll

The interface to implement for processing a specific type of query string parameter.

public interface IQueryStringParameterReader

Properties

AllowEmptyValue

Indicates whether this reader supports empty query string parameter values.

bool AllowEmptyValue { get; }

Property Value

bool

Methods

CanRead(string)

Indicates whether this reader can handle the specified query string parameter.

bool CanRead(string parameterName)

Parameters

parameterName string

Returns

bool

IsEnabled(DisableQueryStringAttribute)

Indicates whether usage of this query string parameter is blocked using DisableQueryStringAttribute on a controller.

bool IsEnabled(DisableQueryStringAttribute disableQueryStringAttribute)

Parameters

disableQueryStringAttribute DisableQueryStringAttribute

Returns

bool

Read(string, StringValues)

Reads the value of the query string parameter.

void Read(string parameterName, StringValues parameterValue)

Parameters

parameterName string

parameterValue StringValues