SelectExpandQueryOption 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.

Represents the OData $select and $expand query options.

public class SelectExpandQueryOption

type SelectExpandQueryOption = class

Public Class SelectExpandQueryOption

Inheritance: Object
SelectExpandQueryOption

Constructors

SelectExpandQueryOption(String, String, ODataQueryContext, ODataQueryOptionParser)

Initializes a new instance of the SelectExpandQueryOption class.

Properties

Context	Gets the given ODataQueryContext.
LevelsMaxLiteralExpansionDepth	Gets or sets the number of levels that a top level $expand=NavigationProperty($levels=max) will be expanded. This value will decrease by one with each nesting level in the $expand clause. For example, with a property value 5, the following query $expand=A($expand=B($expand=C($levels=max))) will be interpreted as $expand=A($expand=B($expand=C($levels=3))). If the query gets validated, the MaxExpansionDepth value must be greater than or equal to this value.
RawExpand	Gets the raw $expand value.
RawSelect	Gets the raw $select value.
SelectExpandClause	Gets the parsed SelectExpandClause for this query option.
Validator	Gets or sets the $select and $expand query validator.

Methods

ApplyTo(IQueryable, ODataQuerySettings)	Applies the $select and $expand query options to the given IQueryable using the given ODataQuerySettings.
ApplyTo(Object, ODataQuerySettings)	Applies the $select and $expand query options to the given entity using the given ODataQuerySettings.
Validate(ODataValidationSettings)	Validate the $select and $expand query based on the given `validationSettings`. It throws an ODataException if validation failed.

Applies to

Share via