ODataQueryOptions<TEntity> Class

Article
10/28/2015

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

Namespace: System.Web.Http.OData.Query
Assembly: System.Web.Http.OData (in System.Web.Http.OData.dll)

Inheritance Hierarchy

System.Object
System.Web.Http.OData.Query.ODataQueryOptions
System.Web.Http.OData.Query.ODataQueryOptions<TEntity>

Syntax

[ODataQueryParameterBindingAttribute]
public class ODataQueryOptions<TEntity> : ODataQueryOptions

generic<typename TEntity>
[ODataQueryParameterBindingAttribute]
public ref class ODataQueryOptions : ODataQueryOptions

[<ODataQueryParameterBindingAttribute>]
type ODataQueryOptions<'TEntity> = 
    class
        inherit ODataQueryOptions
    end

<ODataQueryParameterBindingAttribute>
Public Class ODataQueryOptions(Of TEntity)
    Inherits ODataQueryOptions

Constructors

	Name	Description
	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

	Name	Description
	Context	Gets the given ODataQueryContext(Inherited from ODataQueryOptions.)
	Filter	Gets the FilterQueryOption. (Inherited from ODataQueryOptions.)
	IfMatch	Gets the ETag<TEntity> from IfMatch header, if any.
	IfNoneMatch	Gets the ETag<TEntity> from IfNoneMatch header, if any.
	InlineCount	Gets the InlineCountQueryOption. (Inherited from ODataQueryOptions.)
	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.)
	Top	Gets the TopQueryOption. (Inherited from ODataQueryOptions.)
	Validator	Gets or sets the query validator. (Inherited from ODataQueryOptions.)

Methods

	Name	Description
	ApplyTo(IQueryable)	Apply the individual query to the given IQueryable in the right order. (Overrides ODataQueryOptions.ApplyTo(IQueryable).)
	ApplyTo(IQueryable, ODataQuerySettings)	Apply the individual query to the given IQueryable in the right order. (Overrides ODataQueryOptions.ApplyTo(IQueryable, ODataQuerySettings).)
	ApplyTo(Object, ODataQuerySettings)	Applies the query to the given entity using the given ODataQuerySettings. (Inherited from ODataQueryOptions.)
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	MemberwiseClone()	(Inherited from Object.)
	ToString()	(Inherited from Object.)
	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.)

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via