ODataQueryOptions<TEntity> Class

Reference

Definition

Namespace:: Microsoft.AspNet.OData.Query

Assembly:: Microsoft.AspNet.OData.dll

Assembly:: Microsoft.AspNetCore.OData.dll

Package:: Microsoft.AspNet.OData v7.5.8

Package:: Microsoft.AspNetCore.OData v7.5.8

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

This defines a composite OData query options that can be used to perform query composition. Currently this only supports $filter, $orderby, $top, $skip.

[Microsoft.AspNet.OData.ODataQueryParameterBinding]
public class ODataQueryOptions<TEntity> : Microsoft.AspNet.OData.Query.ODataQueryOptions

[<Microsoft.AspNet.OData.ODataQueryParameterBinding>]
type ODataQueryOptions<'Entity> = class
    inherit ODataQueryOptions

Public Class ODataQueryOptions(Of TEntity)
Inherits ODataQueryOptions

Type Parameters

TEntity

Inheritance: Object

ODataQueryOptions
ODataQueryOptions<TEntity>

Attributes: ODataQueryParameterBindingAttribute

Constructors

ODataQueryOptions<TEntity>(ODataQueryContext, HttpRequest)	Initializes a new instance of the ODataQueryOptions class based on the incoming request and some metadata information from the ODataQueryContext.
ODataQueryOptions<TEntity>(ODataQueryContext, HttpRequestMessage)	Initializes a new instance of the ODataQueryOptions class based on the incoming request and some metadata information from the ODataQueryContext.

Properties

Apply	Gets the ApplyQueryOption. (Inherited from ODataQueryOptions)
Context	Gets the given ODataQueryContext (Inherited from ODataQueryOptions)
Count	Gets the CountQueryOption. (Inherited from ODataQueryOptions)
Filter	Gets the FilterQueryOption. (Inherited from ODataQueryOptions)
IfMatch	Gets the ETag<TEntity> from IfMatch header.
IfNoneMatch	Gets the ETag<TEntity> from IfNoneMatch header.
OrderBy	Gets the OrderByQueryOption. (Inherited from ODataQueryOptions)
RawValues	Gets the raw string of all the OData query options (Inherited from ODataQueryOptions)
Request	Gets the request message associated with this instance. (Inherited from ODataQueryOptions)
SelectExpand	Gets the SelectExpandQueryOption. (Inherited from ODataQueryOptions)
Skip	Gets the SkipQueryOption. (Inherited from ODataQueryOptions)
SkipToken	Gets the SkipTokenQueryOption. (Inherited from ODataQueryOptions)
Top	Gets the TopQueryOption. (Inherited from ODataQueryOptions)
Validator	Gets or sets the query validator. (Inherited from ODataQueryOptions)

Methods

ApplyTo(IQueryable)	Apply the individual query to the given IQueryable in the right order.
ApplyTo(IQueryable, AllowedQueryOptions)	Apply the individual query to the given IQueryable in the right order. (Inherited from ODataQueryOptions)
ApplyTo(IQueryable, ODataQuerySettings)	Apply the individual query to the given IQueryable in the right order.
ApplyTo(IQueryable, ODataQuerySettings, AllowedQueryOptions)	Apply the individual query to the given IQueryable in the right order. (Inherited from ODataQueryOptions)
ApplyTo(Object, ODataQuerySettings)	Applies the query to the given entity using the given ODataQuerySettings. (Inherited from ODataQueryOptions)
ApplyTo(Object, ODataQuerySettings, AllowedQueryOptions)	Apply the individual query to the given IQueryable in the right order. (Inherited from ODataQueryOptions)
GenerateStableOrder()	Generates the Stable OrderBy query option based on the existing OrderBy and other query options. (Inherited from ODataQueryOptions)
IsSupportedQueryOption(String)	Check if the given query option is the supported query option. (Inherited from ODataQueryOptions)
Validate(ODataValidationSettings)	Validate all OData queries, including $skip, $top, $orderby and $filter, based on the given `validationSettings`. It throws an ODataException if validation failed. (Inherited from ODataQueryOptions)

Applies to