ODataOptions Class

Definition

Namespace:

Microsoft.AspNetCore.OData

Assembly:

Microsoft.AspNetCore.OData.dll

Package:

Microsoft.AspNetCore.OData v8.0.1

Contains the detail configurations of a given OData request.

public class ODataOptions

type ODataOptions = class

Public Class ODataOptions

Inheritance

Object

ODataOptions

Remarks

Caution: The properties in this class should not be null.

Constructors

ODataOptions()

Properties

Conventions	Gets the routing conventions.
EnableAttributeRouting	Gets or sets a value indicating if attribute routing is enabled or not. Defaults to true.
EnableContinueOnErrorHeader	Gets or sets a value indicating if batch requests should continue on error. By default, it's false.
EnableNoDollarQueryOptions	Gets or sets whether or not the OData system query options should be prefixed with '$'.
QuerySettings	Gets the query setting.
RouteComponents	Contains the OData IEdmModel instances and dependency injection containers for specific routes.
RouteOptions	Gets the RouteOptions instance responsible for configuring the route templating.
TimeZone	Gets or sets a TimeZoneInfo for the DateTime serialization and deserialization.
UrlKeyDelimiter	Gets or sets the ODataUrlKeyDelimiter to use while parsing, specifically whether to recognize keys as segments or not. By default, it supports key as segment only if the key is single key.

Methods

AddRouteComponents(IEdmModel)	Adds an IEdmModel to the default route.
AddRouteComponents(IEdmModel, ODataBatchHandler)	Adds an IEdmModel, as well as the given ODataBatchHandler, to the default route.
AddRouteComponents(String, IEdmModel)	Adds an IEdmModel to the specified route.
AddRouteComponents(String, IEdmModel, Action<IServiceCollection>)	Adds an IEdmModel using the service configuration.
AddRouteComponents(String, IEdmModel, ODataBatchHandler)	Adds an IEdmModel, as well as the given ODataBatchHandler, to the specified route.
Count()	Enable $count query options.
EnableQueryFeatures(Nullable<Int32>)	Enables all OData query features in one command.
Expand()	Enable $expand query options.
Filter()	Enable $filter query options.
GetRouteServices(String)	Get the root service provider for a given route (prefix) name.
OrderBy()	Enable $orderby query options.
Select()	Enable $select query options.
SetMaxTop(Nullable<Int32>)	Sets the maximum value of $top that a client can request.
SkipToken()	Enable $skiptop query option.