<?xml version="1.0" encoding="utf-8"?>
|
<doc>
|
<assembly>
|
<name>System.Web.Http.OData</name>
|
</assembly>
|
<members>
|
<member name="T:System.Net.Http.ODataHttpRequestMessageExtensions">
|
<summary>Provides extension methods for the <see cref="T:System.Net.Http.HttpRequestMessage" /> class.</summary>
|
</member>
|
<member name="M:System.Net.Http.ODataHttpRequestMessageExtensions.CreateODataErrorResponse(System.Net.Http.HttpRequestMessage,System.Net.HttpStatusCode,Microsoft.Data.OData.ODataError)">
|
<summary>Helper method that performs content negotiation and creates a <see cref="T:System.Net.Http.HttpResponseMessage" /> representing an error with an instance of <see cref="T:System.Net.Http.ObjectContent`1" /> wrapping <paramref name="oDataError" /> as the content. If no formatter is found, this method returns a response with status 406 NotAcceptable.</summary>
|
<returns>An error response wrapping <paramref name="oDataError" /> with status code <paramref name="statusCode" /> .</returns>
|
<param name="request">The request.</param>
|
<param name="statusCode">The status code of the created response.</param>
|
<param name="oDataError">The OData error to wrap.</param>
|
</member>
|
<member name="M:System.Net.Http.ODataHttpRequestMessageExtensions.GetEdmModel(System.Net.Http.HttpRequestMessage)">
|
<summary>Retrieves the EDM model associated with the request.</summary>
|
<returns>The EDM model associated with this request, or null if there isn't one.</returns>
|
<param name="request">The request.</param>
|
</member>
|
<member name="M:System.Net.Http.ODataHttpRequestMessageExtensions.GetInlineCount(System.Net.Http.HttpRequestMessage)">
|
<summary>Gets the inline count to use in the OData response.</summary>
|
<returns>The inline count to send back, or null if one isn't set.</returns>
|
<param name="request">The request.</param>
|
</member>
|
<member name="M:System.Net.Http.ODataHttpRequestMessageExtensions.GetNextPageLink(System.Net.Http.HttpRequestMessage)">
|
<summary>Gets the next page link to use in the OData response.</summary>
|
<returns>The next page link to send back, or null if one isn't set.</returns>
|
<param name="request">The request.</param>
|
</member>
|
<member name="M:System.Net.Http.ODataHttpRequestMessageExtensions.GetODataPath(System.Net.Http.HttpRequestMessage)">
|
<summary>Gets the OData path of the request.</summary>
|
<returns>The OData path of the request</returns>
|
<param name="request">The request.</param>
|
</member>
|
<member name="M:System.Net.Http.ODataHttpRequestMessageExtensions.GetODataPathHandler(System.Net.Http.HttpRequestMessage)">
|
<summary>Gets the <see cref="T:System.Web.Http.OData.Routing.IODataPathHandler" /> to use for generating links.</summary>
|
<returns>The <see cref="T:System.Web.Http.OData.Routing.IODataPathHandler" /> to use for generating links.</returns>
|
<param name="request">The request.</param>
|
</member>
|
<member name="M:System.Net.Http.ODataHttpRequestMessageExtensions.GetODataRouteName(System.Net.Http.HttpRequestMessage)">
|
<summary>Retrieves the route name to use for generating OData links.</summary>
|
<returns>The route name to use for generating OData links associated with this request, or null if there isn't one.</returns>
|
<param name="request">The request.</param>
|
</member>
|
<member name="M:System.Net.Http.ODataHttpRequestMessageExtensions.GetODataRoutingConventions(System.Net.Http.HttpRequestMessage)">
|
<summary>Gets the OData routing conventions to use for controller and action selection.</summary>
|
<returns>The OData routing conventions to use for controller and action selection associated with this request, or null if there aren't any.</returns>
|
<param name="request">The request.</param>
|
</member>
|
<member name="M:System.Net.Http.ODataHttpRequestMessageExtensions.SetEdmModel(System.Net.Http.HttpRequestMessage,Microsoft.Data.Edm.IEdmModel)">
|
<summary>Associates the given EDM model with the request.</summary>
|
<param name="request">The request.</param>
|
<param name="model">The EDM model to associate with the request.</param>
|
</member>
|
<member name="M:System.Net.Http.ODataHttpRequestMessageExtensions.SetInlineCount(System.Net.Http.HttpRequestMessage,System.Int64)">
|
<summary>Sets the inline count to use in the OData response.</summary>
|
<param name="request">The request.</param>
|
<param name="inlineCount">The inline count to send back to the client.</param>
|
</member>
|
<member name="M:System.Net.Http.ODataHttpRequestMessageExtensions.SetNextPageLink(System.Net.Http.HttpRequestMessage,System.Uri)">
|
<summary>Sets the next page link to use in the OData response.</summary>
|
<param name="request">The request.</param>
|
<param name="nextPageLink">The next page link to send back to the client.</param>
|
</member>
|
<member name="M:System.Net.Http.ODataHttpRequestMessageExtensions.SetODataPath(System.Net.Http.HttpRequestMessage,System.Web.Http.OData.Routing.ODataPath)">
|
<summary>Sets the OData path for the request.</summary>
|
<param name="request">The request.</param>
|
<param name="odataPath">The OData path of the request.</param>
|
</member>
|
<member name="M:System.Net.Http.ODataHttpRequestMessageExtensions.SetODataPathHandler(System.Net.Http.HttpRequestMessage,System.Web.Http.OData.Routing.IODataPathHandler)">
|
<summary>Sets the <see cref="T:System.Web.Http.OData.Routing.IODataPathHandler" /> to use for generating links.</summary>
|
<param name="request">The request.</param>
|
<param name="pathHandler">The <see cref="T:System.Web.Http.OData.Routing.IODataPathHandler" /> to use for generating links.</param>
|
</member>
|
<member name="M:System.Net.Http.ODataHttpRequestMessageExtensions.SetODataRouteName(System.Net.Http.HttpRequestMessage,System.String)">
|
<summary>Sets the given route name to be used for generating OData links.</summary>
|
<param name="request">The request.</param>
|
<param name="routeName">The route name to use for generating OData links.</param>
|
</member>
|
<member name="M:System.Net.Http.ODataHttpRequestMessageExtensions.SetODataRoutingConventions(System.Net.Http.HttpRequestMessage,System.Collections.Generic.IEnumerable{System.Web.Http.OData.Routing.Conventions.IODataRoutingConvention})">
|
<summary>Sets the OData routing conventions to use for controller and action selection.</summary>
|
<param name="request">The request.</param>
|
<param name="routingConventions">The OData routing conventions to use for controller and action selection.</param>
|
</member>
|
<member name="T:System.Web.Http.ODataHttpConfigurationExtensions">
|
<summary>Provides extension methods for the <see cref="T:System.Web.Http.HttpConfiguration" /> class.</summary>
|
</member>
|
<member name="M:System.Web.Http.ODataHttpConfigurationExtensions.EnableQuerySupport(System.Web.Http.HttpConfiguration)">
|
<summary>Enables query support for actions with a <see cref="T:System.Linq.IQueryable" /> or <see cref="T:System.Linq.IQueryable`1" /> return type. </summary>
|
<param name="configuration">The server configuration.</param>
|
</member>
|
<member name="M:System.Web.Http.ODataHttpConfigurationExtensions.EnableQuerySupport(System.Web.Http.HttpConfiguration,System.Web.Http.Filters.IActionFilter)">
|
<summary>Enables query support for actions with a <see cref="T:System.Linq.IQueryable" /> or <see cref="T:System.Linq.IQueryable`1" /> return type.</summary>
|
<param name="configuration">The server configuration.</param>
|
<param name="queryFilter">The action filter that executes the query.</param>
|
</member>
|
<member name="T:System.Web.Http.ODataHttpErrorExtensions">
|
<summary>Provides extension methods for the <see cref="T:System.Web.Http.HttpError" /> class.</summary>
|
</member>
|
<member name="M:System.Web.Http.ODataHttpErrorExtensions.ToODataError(System.Web.Http.HttpError)">
|
<summary>Converts the <paramref name="httpError" /> to an <see cref="T:Microsoft.Data.OData.ODataError" /> .</summary>
|
<returns>The converted <see cref="T:Microsoft.Data.OData.ODataError" /></returns>
|
<param name="httpError">The <see cref="T:System.Web.Http.HttpError" /> instance to convert.</param>
|
</member>
|
<member name="T:System.Web.Http.ODataHttpRouteCollectionExtensions">
|
<summary>Provides extension methods for the <see cref="T:System.Web.Http.HttpRouteCollection" /> class.</summary>
|
</member>
|
<member name="M:System.Web.Http.ODataHttpRouteCollectionExtensions.MapODataRoute(System.Web.Http.HttpRouteCollection,System.String,System.String,Microsoft.Data.Edm.IEdmModel)">
|
<summary>Maps the specified OData route.</summary>
|
<param name="routes">A collection of routes for the application.</param>
|
<param name="routeName">The name of the route to map.</param>
|
<param name="routePrefix">The prefix to add to the OData route's path template.</param>
|
<param name="model">The EDM model to use for parsing OData paths.</param>
|
</member>
|
<member name="M:System.Web.Http.ODataHttpRouteCollectionExtensions.MapODataRoute(System.Web.Http.HttpRouteCollection,System.String,System.String,Microsoft.Data.Edm.IEdmModel,System.Web.Http.OData.Routing.IODataPathHandler,System.Collections.Generic.IEnumerable{System.Web.Http.OData.Routing.Conventions.IODataRoutingConvention})">
|
<summary>Maps the specified OData route.</summary>
|
<param name="routes">A collection of routes for the application.</param>
|
<param name="routeName">The name of the route to map.</param>
|
<param name="routePrefix">The prefix to add to the OData route's path template.</param>
|
<param name="model">The EDM model to use for parsing OData paths.</param>
|
<param name="pathHandler">The <see cref="T:System.Web.Http.OData.Routing.IODataPathHandler" /> to use for parsing the OData path.</param>
|
<param name="routingConventions">The OData routing conventions to use for controller and action selection.</param>
|
</member>
|
<member name="T:System.Web.Http.ODataMediaTypeFormatterCollectionExtensions">
|
<summary>Provides extension methods for the <see cref="T:System.Net.Http.Formatting.MediaTypeFormatterCollection" /> class.</summary>
|
</member>
|
<member name="M:System.Web.Http.ODataMediaTypeFormatterCollectionExtensions.AddRange(System.Net.Http.Formatting.MediaTypeFormatterCollection,System.Collections.Generic.IEnumerable{System.Net.Http.Formatting.MediaTypeFormatter})">
|
<summary>Adds the elements of the specified collection to the end of the <see cref="T:System.Net.Http.Formatting.MediaTypeFormatterCollection" /> .</summary>
|
<param name="collection">The collection to which to add the items.</param>
|
<param name="items">The items that should be added to the end of the <see cref="T:System.Net.Http.Formatting.MediaTypeFormatterCollection" /> . The items collection itself cannot be <see cref="null" /> , but it can contain elements that are <see cref="null" /> .</param>
|
</member>
|
<member name="M:System.Web.Http.ODataMediaTypeFormatterCollectionExtensions.InsertRange(System.Net.Http.Formatting.MediaTypeFormatterCollection,System.Int32,System.Collections.Generic.IEnumerable{System.Net.Http.Formatting.MediaTypeFormatter})">
|
<summary>Inserts the elements of a collection into the <see cref="T:System.Net.Http.Formatting.MediaTypeFormatterCollection" /> at the specified index.</summary>
|
<param name="index">The zero-based index at which the new elements should be inserted.</param>
|
<param name="items">The items that should be inserted into the <see cref="T:System.Net.Http.Formatting.MediaTypeFormatterCollection" /> . The items collection itself cannot be <see cref="null" /> , but it can contain elements that are <see cref="null" /> .</param>
|
</member>
|
<member name="T:System.Web.Http.ODataUrlHelperExtensions">
|
<summary>Provides extension methods for the <see cref="T:System.Web.Http.Routing.UrlHelper" /> class.</summary>
|
</member>
|
<member name="M:System.Web.Http.ODataUrlHelperExtensions.ODataLink(System.Web.Http.Routing.UrlHelper,System.Collections.Generic.IList{System.Web.Http.OData.Routing.ODataPathSegment})">
|
<summary>Generates an OData link.</summary>
|
<returns>Returns <see cref="T:System.String" />.</returns>
|
<param name="urlHelper">The URL helper.</param>
|
<param name="segments">The OData path segments.</param>
|
</member>
|
<member name="M:System.Web.Http.ODataUrlHelperExtensions.ODataLink(System.Web.Http.Routing.UrlHelper,System.String,System.Web.Http.OData.Routing.IODataPathHandler,System.Collections.Generic.IList{System.Web.Http.OData.Routing.ODataPathSegment})">
|
<summary>Generates an OData link using the request's OData route name and path handler.</summary>
|
<returns>Returns <see cref="T:System.String" />.</returns>
|
<param name="urlHelper">The URL helper.</param>
|
<param name="routeName">The name of the OData route.</param>
|
<param name="pathHandler">The path handler to use for generating the link.</param>
|
<param name="segments">The OData path segments.</param>
|
</member>
|
<member name="M:System.Web.Http.ODataUrlHelperExtensions.ODataLink(System.Web.Http.Routing.UrlHelper,System.Web.Http.OData.Routing.ODataPathSegment[])">
|
<summary>Generates an OData link.</summary>
|
<returns>Returns <see cref="T:System.String" />.</returns>
|
<param name="urlHelper">The URL helper.</param>
|
<param name="segments">The OData path segments.</param>
|
</member>
|
<member name="T:System.Web.Http.QueryableAttribute">
|
<summary>This class defines an attribute that can be applied to an action to enable querying using the OData query syntax. To avoid processing unexpected or malicious queries, use the validation settings on <see cref="T:System.Web.Http.QueryableAttribute" /> to validate incoming queries. For more information, visit http://go.microsoft.com/fwlink/?LinkId=279712.</summary>
|
</member>
|
<member name="M:System.Web.Http.QueryableAttribute.#ctor">
|
<summary>Enables a controller action to support OData query parameters.</summary>
|
</member>
|
<member name="P:System.Web.Http.QueryableAttribute.AllowedArithmeticOperators">
|
<summary>Gets or sets a value that represents a list of allowed arithmetic operators including 'add', 'sub', 'mul', 'div', 'mod'.</summary>
|
<returns>Returns <see cref="T:System.Web.Http.OData.Query.AllowedArithmeticOperators" />.</returns>
|
</member>
|
<member name="P:System.Web.Http.QueryableAttribute.AllowedFunctions">
|
<summary>Gets or sets a value that represents a list of allowed functions used in the $filter query. The allowed functions include the following: String related: substringof, endswith, startswith, length, indexof, substring, tolower, toupper, trim, concat e.g. ~/Customers?$filter=length(CompanyName) eq 19 DateTime related: year, years, month, months, day, days, hour, hours, minute, minutes, second, seconds e.g. ~/Employees?$filter=year(BirthDate) eq 1971 Math related: round, floor, ceiling Type related:isof, cast, Collection related: any, all</summary>
|
<returns>Returns <see cref="T:System.Web.Http.OData.Query.AllowedFunctions" />.</returns>
|
</member>
|
<member name="P:System.Web.Http.QueryableAttribute.AllowedLogicalOperators">
|
<summary>Gets or sets a value that represents a list of allowed logical Operators such as 'eq', 'ne', 'gt', 'ge', 'lt', 'le', 'and', 'or', 'not'.</summary>
|
<returns>Returns <see cref="T:System.Web.Http.OData.Query.AllowedLogicalOperators" />.</returns>
|
</member>
|
<member name="P:System.Web.Http.QueryableAttribute.AllowedOrderByProperties">
|
<summary>Gets or sets a string with comma-separated list of property names. The queriable result can only be ordered by those properties defined in this list. Note, by default this string is null, which means it can be ordered by any property. For example, setting this value to null or empty string means that we allow ordering the queriable result by any properties. Setting this value to "Name" means we only allow queriable result to be ordered by Name property.</summary>
|
<returns>Returns <see cref="T:System.String" />.</returns>
|
</member>
|
<member name="P:System.Web.Http.QueryableAttribute.AllowedQueryOptions">
|
<summary>Gets or sets the query parameters that are allowed in queries. The default is all query options, including $filter, $skip, $top, $orderby, $expand, $select, $inlineCount, $format and $skiptoken.</summary>
|
<returns>Returns <see cref="T:System.Web.Http.OData.Query.AllowedQueryOptions" />.</returns>
|
</member>
|
<member name="M:System.Web.Http.QueryableAttribute.ApplyQuery(System.Linq.IQueryable,System.Web.Http.OData.Query.ODataQueryOptions)">
|
<summary>Applies the query to the given IQueryable based on incoming query from uri and query settings.</summary>
|
<returns>Returns <see cref="T:System.Linq.IQueryable" />.</returns>
|
<param name="queryable">The original queriable instance from the response message.</param>
|
<param name="queryOptions">The <see cref="T:System.Web.Http.OData.Query.ODataQueryOptions" /> instance constructed based on the incoming request.</param>
|
</member>
|
<member name="P:System.Web.Http.QueryableAttribute.EnableConstantParameterization">
|
<summary>Gets or sets a value indicating whether constants should be parameterized. Parameterizing constants would result in better performance with Entity framework.</summary>
|
<returns>The default value is true .</returns>
|
</member>
|
<member name="P:System.Web.Http.QueryableAttribute.EnsureStableOrdering">
|
<summary>Gets or sets a value indicating whether query composition should alter the original query when necessary to ensure a stable sort order.</summary>
|
<returns>A true value indicates the original query should be modified when necessary to guarantee a stable sort order. A false value indicates the sort order can be considered stable without modifying the query. Query providers that ensure a stable sort order should set this value to false . The default value is true .</returns>
|
</member>
|
<member name="M:System.Web.Http.QueryableAttribute.GetModel(System.Type,System.Net.Http.HttpRequestMessage,System.Web.Http.Controllers.HttpActionDescriptor)">
|
<summary>Gets the EDM model for the given type and request.</summary>
|
<returns>The EDM model for the given type and request.</returns>
|
<param name="elementClrType">The CLR type to retrieve a model for.</param>
|
<param name="request">The request message to retrieve a model for.</param>
|
<param name="actionDescriptor">The action descriptor for the action being queried on.</param>
|
</member>
|
<member name="P:System.Web.Http.QueryableAttribute.HandleNullPropagation">
|
<summary>Gets or sets a value indicating how null propagation should be handled during query composition.</summary>
|
<returns>The default is <see cref="F:System.Web.Http.OData.Query.HandleNullPropagationOption.Default" /> .</returns>
|
</member>
|
<member name="P:System.Web.Http.QueryableAttribute.MaxAnyAllExpressionDepth">
|
<summary>Gets or sets the maximum depth of the Any or All elements nested inside the query.</summary>
|
<returns>The maximum depth of the Any or All elements nested inside the query.</returns>
|
</member>
|
<member name="P:System.Web.Http.QueryableAttribute.MaxNodeCount">
|
<summary>Gets or sets the maximum number of nodes inside the $filter syntax tree.</summary>
|
<returns>Returns <see cref="T:System.Int32" />.</returns>
|
</member>
|
<member name="P:System.Web.Http.QueryableAttribute.MaxSkip">
|
<summary>Gets or sets the max value of $skip that a client can request.</summary>
|
<returns>Returns <see cref="T:System.Int32" />.</returns>
|
</member>
|
<member name="P:System.Web.Http.QueryableAttribute.MaxTop">
|
<summary>Gets or sets the max value of $top that a client can request.</summary>
|
<returns>Returns <see cref="T:System.Int32" />.</returns>
|
</member>
|
<member name="M:System.Web.Http.QueryableAttribute.OnActionExecuted(System.Web.Http.Filters.HttpActionExecutedContext)">
|
<summary>Performs the query composition after action is executed. It first tries to retrieve the IQueryable from the returning response message. It then validates the query from uri based on the validation settings on QueryableAttribute. It finally applies the query appropriately, and reset it back on the response message.</summary>
|
<param name="actionExecutedContext">The context related to this action, including the response message, request message and HttpConfiguration etc.</param>
|
</member>
|
<member name="P:System.Web.Http.QueryableAttribute.PageSize">
|
<summary>Gets or sets the maximum number of query results to send back to clients.</summary>
|
<returns>The maximum number of query results to send back to clients.</returns>
|
</member>
|
<member name="M:System.Web.Http.QueryableAttribute.ValidateQuery(System.Net.Http.HttpRequestMessage,System.Web.Http.OData.Query.ODataQueryOptions)">
|
<summary>Validates the OData query in the incoming request.</summary>
|
<param name="request">The incoming request.</param>
|
<param name="queryOptions">The <see cref="T:System.Web.Http.OData.Query.ODataQueryOptions" /> instance constructed based on the incoming request.</param>
|
</member>
|
<member name="T:System.Web.Http.OData.AsyncEntitySetController`2">
|
<summary>Provides a convenient starting point for a controller that exposes an OData entity set. This is the asynchronous version of <see cref="T:System.Web.Http.OData.EntitySetController`2" /> .</summary>
|
<typeparam name="TEntity">The type associated with the exposed entity set's entity type.</typeparam>
|
<typeparam name="TKey">The type associated with the entity key of the exposed entity set's entity type.</typeparam>
|
</member>
|
<member name="M:System.Web.Http.OData.AsyncEntitySetController`2.#ctor">
|
<summary>Initializes a new instance of <see cref="T:System.Web.Http.OData.AsyncEntitySetController`2" />. </summary>
|
</member>
|
<member name="M:System.Web.Http.OData.AsyncEntitySetController`2.CreateEntityAsync(`0)">
|
<summary>This method should be overridden to create a new entity in the entity set.</summary>
|
<returns>A <see cref="T:System.Threading.Tasks.Task" /> that contains the created entity when it completes.</returns>
|
<param name="entity">The entity to add to the entity set.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.AsyncEntitySetController`2.CreateLink(`1,System.String,System.Uri)">
|
<summary>This method should be overridden to handle POST and PUT requests that attempt to create a link between two entities.</summary>
|
<returns>A <see cref="T:System.Threading.Tasks.Task" /> that completes when the link has been successfully created.</returns>
|
<param name="key">The key of the entity with the navigation property.</param>
|
<param name="navigationProperty">The name of the navigation property.</param>
|
<param name="link">The URI of the entity to link.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.AsyncEntitySetController`2.Delete(`1)">
|
<summary>This method should be overridden to handles DELETE requests for deleting existing entities from the entity set.</summary>
|
<returns>A <see cref="T:System.Threading.Tasks.Task" /> that completes when the entity has been successfully deleted.</returns>
|
<param name="key">The entity key of the entity to delete.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.AsyncEntitySetController`2.DeleteLink(`1,System.String,System.String)">
|
<summary>This method should be overridden to handle DELETE requests that attempt to break a relationship between two entities.</summary>
|
<returns>Returns <see cref="T:System.Threading.Tasks.Task" />.</returns>
|
<param name="key">The key of the entity with the navigation property.</param>
|
<param name="relatedKey">The key of the related entity.</param>
|
<param name="navigationProperty">The name of the navigation property.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.AsyncEntitySetController`2.DeleteLink(`1,System.String,System.Uri)">
|
<summary> This method should be overridden to handle DELETE requests that attempt to break a relationship between two entities.</summary>
|
<returns>Returns <see cref="T:System.Threading.Tasks.Task" />.</returns>
|
<param name="key">The key of the entity with the navigation property.</param>
|
<param name="navigationProperty">The name of the navigation property.</param>
|
<param name="link">The URI of the entity to remove from the navigation property.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.AsyncEntitySetController`2.Get">
|
<summary>This method should be overridden to handle GET requests that attempt to retrieve entities from the entity set. </summary>
|
<returns>The matching entities from the entity set.</returns>
|
</member>
|
<member name="M:System.Web.Http.OData.AsyncEntitySetController`2.Get(`1)">
|
<summary>Handles GET requests that attempt to retrieve an individual entity by key from the entity set.</summary>
|
<returns>Returns <see cref="T:System.Threading.Tasks.Task`1" />.</returns>
|
<param name="key">The entity key of the entity to retrieve.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.AsyncEntitySetController`2.GetEntityByKeyAsync(`1)">
|
<summary>This method should be overridden to retrieve an entity by key from the entity set.</summary>
|
<returns>A <see cref="T:System.Threading.Tasks.Task" /> that contains the retrieved entity when it completes, or null if an entity with the specified entity key cannot be found in the entity set.</returns>
|
<param name="key">The entity key of the entity to retrieve.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.AsyncEntitySetController`2.GetKey(`0)">
|
<summary>This method should be overridden to get the entity key of the specified entity.</summary>
|
<returns>The entity key value</returns>
|
<param name="entity">The entity.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.AsyncEntitySetController`2.HandleUnmappedRequest(System.Web.Http.OData.Routing.ODataPath)">
|
<summary>This method should be overridden to handle all unmapped OData requests.</summary>
|
<returns>A <see cref="T:System.Threading.Tasks.Task" /> that contains the response message to send back to the client when it completes.</returns>
|
<param name="odataPath">The OData path of the request.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.AsyncEntitySetController`2.ODataPath">
|
<summary>Gets the OData path of the current request.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.AsyncEntitySetController`2.Patch(`1,System.Web.Http.OData.Delta{`0})">
|
<summary>Handles PATCH and MERGE requests to partially update a single entity in the entity set.</summary>
|
<returns>A <see cref="T:System.Threading.Tasks.Task" /> that contains the response message to send back to the client when it completes.</returns>
|
<param name="key">The entity key of the entity to update.</param>
|
<param name="patch">The patch representing the partial update.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.AsyncEntitySetController`2.PatchEntityAsync(`1,System.Web.Http.OData.Delta{`0})">
|
<summary>This method should be overridden to apply a partial update to an existing entity in the entity set.</summary>
|
<returns>A <see cref="T:System.Threading.Tasks.Task" /> that contains the updated entity when it completes.</returns>
|
<param name="key">The entity key of the entity to update.</param>
|
<param name="patch">The patch representing the partial update.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.AsyncEntitySetController`2.Post(`0)">
|
<summary>Handles POST requests that create new entities in the entity set.</summary>
|
<returns>A <see cref="T:System.Threading.Tasks.Task" /> that contains the response message to send back to the client when it completes.</returns>
|
<param name="entity">The entity to insert into the entity set.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.AsyncEntitySetController`2.Put(`1,`0)">
|
<summary>Handles PUT requests that attempt to replace a single entity in the entity set.</summary>
|
<returns>A <see cref="T:System.Threading.Tasks.Task" /> that contains the response message to send back to the client when it completes.</returns>
|
<param name="key">The entity key of the entity to replace.</param>
|
<param name="update">The updated entity.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.AsyncEntitySetController`2.QueryOptions">
|
<summary>Gets the OData query options of the current request.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.AsyncEntitySetController`2.UpdateEntityAsync(`1,`0)">
|
<summary>This method should be overridden to update an existing entity in the entity set.</summary>
|
<returns>A <see cref="T:System.Threading.Tasks.Task" /> that contains the updated entity when it completes.</returns>
|
<param name="key">The entity key of the entity to update.</param>
|
<param name="update">The updated entity.</param>
|
</member>
|
<member name="T:System.Web.Http.OData.ClrTypeAnnotation">
|
<summary>Represents a mapping from an <see cref="T:Microsoft.Data.Edm.IEdmType" /> to a CLR type.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.ClrTypeAnnotation.#ctor(System.Type)">
|
<summary>Initializes a new instance of <see cref="T:System.Web.Http.OData.ClrTypeAnnotation" /> class.</summary>
|
<param name="clrType">The backing CLR type for the EDM type.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.ClrTypeAnnotation.ClrType">
|
<summary>The backing CLR type for the EDM type.</summary>
|
</member>
|
<member name="T:System.Web.Http.OData.Delta`1">
|
<summary>A class the tracks changes (i.e. the delta) for a particular <paramref name="TEntityType" />.</summary>
|
<typeparam name="TEntityType">TEntityType is the base type of entity this delta tracks changes for.</typeparam>
|
</member>
|
<member name="M:System.Web.Http.OData.Delta`1.#ctor">
|
<summary>Initializes a new instance of <see cref="T:System.Web.Http.OData.Delta`1" />.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Delta`1.#ctor(System.Type)">
|
<summary>Initializes a new instance of <see cref="T:System.Web.Http.OData.Delta`1" />.</summary>
|
<param name="entityType">The derived entity type for which the changes would be tracked. <paramref name="entityType" /> should be assignable to instances of <paramref name="TEntityType" />.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Delta`1.Clear">
|
<summary>Clears the Delta and resets the underlying Entity.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Delta`1.CopyChangedValues(`0)">
|
<summary>Copies the changed property values from the underlying entity (accessible via <see cref="M:System.Web.Http.OData.Delta`1.GetEntity" /> to the <paramref name="original" /> entity.</summary>
|
<param name="original">The entity to be updated.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Delta`1.CopyUnchangedValues(`0)">
|
<summary>Copies the unchanged property values from the underlying entity (accessible via <see cref="M:System.Web.Http.OData.Delta`1.GetEntity" />) to the <paramref name="original" /> entity.</summary>
|
<param name="original">The entity to be updated.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Delta`1.EntityType">
|
<summary> The actual type of the entity for which the changes are tracked.</summary>
|
<returns>Returns <see cref="T:System.Type" />.</returns>
|
</member>
|
<member name="M:System.Web.Http.OData.Delta`1.GetChangedPropertyNames">
|
<summary>Returns the Properties that have been modified through this Delta as an enumeration of property names.</summary>
|
<returns>Returns <see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
|
</member>
|
<member name="M:System.Web.Http.OData.Delta`1.GetEntity">
|
<summary>Returns the <see cref="P:System.Web.Http.OData.Delta`1.EntityType" /> instance that holds all the changes (and original values) being tracked by this Delta.</summary>
|
<returns>Returns <see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
|
</member>
|
<member name="M:System.Web.Http.OData.Delta`1.GetUnchangedPropertyNames">
|
<summary> Returns the properties that have not been modified through this Delta as an enumeration of property names</summary>
|
<returns>Returns <see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
|
</member>
|
<member name="M:System.Web.Http.OData.Delta`1.Patch(`0)">
|
<summary>Overwrites the <paramref name="original" /> entity with the changes tracked by this Delta. </summary>
|
<param name="original">The entity to be updated.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Delta`1.Put(`0)">
|
<summary>Overwrites the <paramref name="original" /> entity with the values stored in this Delta.</summary>
|
<param name="original">The entity to be updated.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Delta`1.TryGetMember(System.Dynamic.GetMemberBinder,System.Object@)">
|
<summary>Overrides the DynamicObject TryGetMember method, so that only the properties of <see cref="P:System.Web.Http.OData.Delta`1.EntityType" /> can be got.</summary>
|
<returns>Returns <see cref="T:System.Boolean" />.</returns>
|
</member>
|
<member name="M:System.Web.Http.OData.Delta`1.TryGetPropertyType(System.String,System.Type@)">
|
<summary>Attempts to get the <see cref="T:System.Type" /> of the property called <paramref name="name" /> from the underlying entity.</summary>
|
<returns>true if the property was found; otherwise, false.</returns>
|
<param name="name">The name of the property.</param>
|
<param name="type">The type of the property.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Delta`1.TryGetPropertyValue(System.String,System.Object@)">
|
<summary>Attempts to get the value of the property called <paramref name="name" /> from the underlying entity.</summary>
|
<returns>true if the property was found.</returns>
|
<param name="name">The name of the property.</param>
|
<param name="value">The value of the property.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Delta`1.TrySetMember(System.Dynamic.SetMemberBinder,System.Object)">
|
<summary>Overrides the DynamicObject TrySetMember method, so that only the properties of <see cref="P:System.Web.Http.OData.Delta`1.EntityType" /> can be set.</summary>
|
<returns>Returns <see cref="T:System.Boolean" />.</returns>
|
</member>
|
<member name="M:System.Web.Http.OData.Delta`1.TrySetPropertyValue(System.String,System.Object)">
|
<summary> Attempts to set the property called <paramref name="name" /> to the <paramref name="value" /> specified.</summary>
|
<returns>true if successful; otherwise, false.</returns>
|
<param name="name">The name of the property.</param>
|
<param name="value">The new value of the property.</param>
|
</member>
|
<member name="T:System.Web.Http.OData.EntityInstanceContext">
|
<summary>An instance of <see cref="T:System.Web.Http.OData.EntityInstanceContext`1" /> gets passed to the self link (<see cref="M:EntitySetConfiguration.HasIdLink" />, <see cref="M:EntitySetConfiguration.HasEditLink" />, <see cref="M:EntitySetConfiguration.HasReadLink" />) and navigation link (<see cref="M:EntitySetConfiguration.HasNavigationPropertyLink" />, <see cref="M:EntitySetConfiguration.HasNavigationPropertiesLink" />) builders and can be used by the link builders to generate links.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.EntityInstanceContext.#ctor"></member>
|
<member name="P:System.Web.Http.OData.EntityInstanceContext.EdmModel">
|
<summary>Gets or sets the <see cref="T:Microsoft.Data.Edm.IEdmModel" /> to which this instance belongs.</summary>
|
<returns>Returns <see cref="T:Microsoft.Data.Edm.IEdmModel" />.</returns>
|
</member>
|
<member name="P:System.Web.Http.OData.EntityInstanceContext.EntityInstance">
|
<summary>Gets or sets the value of this entity instance.</summary>
|
<returns>Returns <see cref="T:System.Object" />.</returns>
|
</member>
|
<member name="P:System.Web.Http.OData.EntityInstanceContext.EntitySet">
|
<summary>Gets or sets the <see cref="T:Microsoft.Data.Edm.IEdmEntitySet" /> to which this instance belongs.</summary>
|
<returns>Returns <see cref="T:Microsoft.Data.Edm.IEdmEntitySet" />.</returns>
|
</member>
|
<member name="P:System.Web.Http.OData.EntityInstanceContext.EntityType">
|
<summary>Gets or sets the <see cref="T:Microsoft.Data.Edm.IEdmEntityType" /> of this entity instance.</summary>
|
<returns>Returns <see cref="T:Microsoft.Data.Edm.IEdmEntityType" />.</returns>
|
</member>
|
<member name="P:System.Web.Http.OData.EntityInstanceContext.Request">
|
<summary>Gets or sets the HTTP request that caused this instance to be generated.</summary>
|
<returns>Returns <see cref="T:System.Net.Http.HttpRequestMessage" />.</returns>
|
</member>
|
<member name="P:System.Web.Http.OData.EntityInstanceContext.SkipExpensiveAvailabilityChecks">
|
<summary>Gets or sets a value indicating whether ActionAvailabilityChecks should be performed or not.</summary>
|
<returns>Returns <see cref="T:System.Boolean" />.</returns>
|
</member>
|
<member name="P:System.Web.Http.OData.EntityInstanceContext.Url">
|
<summary>Gets or sets a <see cref="T:System.Web.Http.Routing.UrlHelper" /> that may be used to generate links while serializing this entity instance.</summary>
|
<returns>Returns <see cref="T:System.Web.Http.Routing.UrlHelper" />.</returns>
|
</member>
|
<member name="T:System.Web.Http.OData.EntityInstanceContext`1">
|
<summary>An instance of <see cref="T:System.Web.Http.OData.EntityInstanceContext`1" /> gets passed to the self link (<see cref="M:EntitySetConfiguration.HasIdLink" />, <see cref="M:EntitySetConfiguration.HasEditLink" />, <see cref="M:EntitySetConfiguration.HasReadLink" />) and navigation link (<see cref="M:EntitySetConfiguration.HasNavigationPropertyLink" />, <see cref="M:EntitySetConfiguration.HasNavigationPropertiesLink" />) builders and can be used by the link builders to generate links.</summary>
|
<typeparam name="TEntityType">The entity type.</typeparam>
|
</member>
|
<member name="M:System.Web.Http.OData.EntityInstanceContext`1.#ctor"></member>
|
<member name="P:System.Web.Http.OData.EntityInstanceContext`1.EntityInstance">
|
<summary>Gets or sets the entity instance.</summary>
|
<returns>Returns <see cref="{0}" />.</returns>
|
</member>
|
<member name="T:System.Web.Http.OData.EntitySetController`2">
|
<summary>Provides a convenient starting point for a controller that exposes an OData entity set. This is the synchronous version of <see cref="T:System.Web.Http.OData.AsyncEntitySetController`2" /> .</summary>
|
<typeparam name="TEntity">The type associated with the exposed entity set's entity type.</typeparam>
|
<typeparam name="TKey">The type associated with the entity key of the exposed entity set's entity type.</typeparam>
|
</member>
|
<member name="M:System.Web.Http.OData.EntitySetController`2.#ctor"></member>
|
<member name="M:System.Web.Http.OData.EntitySetController`2.CreateEntity(`0)">
|
<summary>This method should be overridden to create a new entity in the entity set.</summary>
|
<returns>The created entity.</returns>
|
<param name="entity">The entity to add to the entity set.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.EntitySetController`2.CreateLink(`1,System.String,System.Uri)">
|
<summary>This method should be overridden to handle POST and PUT requests that attempt to create a link between two entities.</summary>
|
<param name="key">The key of the entity with the navigation property.</param>
|
<param name="navigationProperty">The name of the navigation property.</param>
|
<param name="link">The URI of the entity to link.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.EntitySetController`2.Delete(`1)">
|
<summary>This method should be overridden to handle DELETE requests for deleting existing entities from the entity set.</summary>
|
<param name="key">The entity key of the entity to delete.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.EntitySetController`2.DeleteLink(`1,System.String,System.String)">
|
<summary>This method should be overridden to handle DELETE requests that attempt to break a relationship between two entities.</summary>
|
<param name="key">The key of the entity with the navigation property.</param>
|
<param name="relatedKey">The key of the related entity.</param>
|
<param name="navigationProperty">The name of the navigation property.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.EntitySetController`2.DeleteLink(`1,System.String,System.Uri)">
|
<summary> This method should be overridden to handle DELETE requests that attempt to break a relationship between two entities.</summary>
|
<param name="key">The key of the entity with the navigation property.</param>
|
<param name="navigationProperty">The name of the navigation property.</param>
|
<param name="link">The URI of the entity to remove from the navigation property.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.EntitySetController`2.Get">
|
<summary>This method should be overridden to handle GET requests that attempt to retrieve entities from the entity set.</summary>
|
<returns>The matching entities from the entity set.</returns>
|
</member>
|
<member name="M:System.Web.Http.OData.EntitySetController`2.Get(`1)">
|
<summary>Handles GET requests that attempt to retrieve an individual entity by key from the entity set.</summary>
|
<returns>The response message to send back to the client.</returns>
|
<param name="key">The entity key of the entity to retrieve.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.EntitySetController`2.GetEntityByKey(`1)">
|
<summary>This method should be overridden to retrieve an entity by key from the entity set.</summary>
|
<returns>The retrieved entity, or null if an entity with the specified entity key cannot be found in the entity set.</returns>
|
<param name="key">The entity key of the entity to retrieve.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.EntitySetController`2.GetKey(`0)">
|
<summary>This method should be overridden to get the entity key of the specified entity.</summary>
|
<returns>The entity key value</returns>
|
<param name="entity">The entity.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.EntitySetController`2.HandleUnmappedRequest(System.Web.Http.OData.Routing.ODataPath)">
|
<summary>This method should be overridden to handle all unmapped OData requests.</summary>
|
<returns>The response message to send back to the client.</returns>
|
<param name="odataPath">The OData path of the request.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.EntitySetController`2.ODataPath">
|
<summary>Gets the OData path of the current request.</summary>
|
<returns>Returns <see cref="T:System.Web.Http.OData.Routing.ODataPath" />.</returns>
|
</member>
|
<member name="M:System.Web.Http.OData.EntitySetController`2.Patch(`1,System.Web.Http.OData.Delta{`0})">
|
<summary>Handles PATCH and MERGE requests to partially update a single entity in the entity set.</summary>
|
<returns>The response message to send back to the client.</returns>
|
<param name="key">The entity key of the entity to update.</param>
|
<param name="patch">The patch representing the partial update.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.EntitySetController`2.PatchEntity(`1,System.Web.Http.OData.Delta{`0})">
|
<summary>This method should be overridden to apply a partial update to an existing entity in the entity set.</summary>
|
<returns>The updated entity.</returns>
|
<param name="key">The entity key of the entity to update.</param>
|
<param name="patch">The patch representing the partial update.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.EntitySetController`2.Post(`0)">
|
<summary>Handles POST requests that create new entities in the entity set.</summary>
|
<returns>The response message to send back to the client.</returns>
|
<param name="entity">The entity to insert into the entity set.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.EntitySetController`2.Put(`1,`0)">
|
<summary>Handles PUT requests that attempt to replace a single entity in the entity set.</summary>
|
<returns>The response message to send back to the client.</returns>
|
<param name="key">The entity key of the entity to replace.</param>
|
<param name="update">The updated entity.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.EntitySetController`2.QueryOptions">
|
<summary>Gets the OData query options of the current request.</summary>
|
<returns>Returns <see cref="T:System.Web.Http.OData.Query.ODataQueryOptions`1" />.</returns>
|
</member>
|
<member name="M:System.Web.Http.OData.EntitySetController`2.UpdateEntity(`1,`0)">
|
<summary>This method should be overridden to update an existing entity in the entity set.</summary>
|
<returns>The updated entity.</returns>
|
<param name="key">The entity key of the entity to update.</param>
|
<param name="update">The updated entity.</param>
|
</member>
|
<member name="T:System.Web.Http.OData.FeedContext">
|
<summary>Contains context information about the feed currently being serialized.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.FeedContext.#ctor"></member>
|
<member name="P:System.Web.Http.OData.FeedContext.EntitySet">
|
<summary>Gets the <see cref="T:Microsoft.Data.Edm.IEdmEntitySet" /> this instance belongs to.</summary>
|
<returns>Returns <see cref="T:Microsoft.Data.Edm.IEdmEntitySet" />.</returns>
|
</member>
|
<member name="P:System.Web.Http.OData.FeedContext.FeedInstance">
|
<summary>Gets the value of this feed instance.</summary>
|
<returns>Returns <see cref="T:System.Object" />.</returns>
|
</member>
|
<member name="P:System.Web.Http.OData.FeedContext.Request">
|
<summary>Gets or sets the HTTP request that caused this instance to be generated.</summary>
|
<returns>Returns <see cref="T:System.Net.Http.HttpRequestMessage" />.</returns>
|
</member>
|
<member name="P:System.Web.Http.OData.FeedContext.Url">
|
<summary>Gets or sets the <see cref="T:System.Web.Http.Routing.UrlHelper" /> to be used for generating links while serializing this feed instance.</summary>
|
<returns>Returns <see cref="T:System.Web.Http.Routing.UrlHelper" />.</returns>
|
</member>
|
<member name="T:System.Web.Http.OData.FromODataUriAttribute">
|
<summary>An implementation of <see cref="T:System.Web.Http.ParameterBindingAttribute" /> that can bind URI parameters using OData conventions.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.FromODataUriAttribute.#ctor"></member>
|
<member name="M:System.Web.Http.OData.FromODataUriAttribute.GetBinding(System.Web.Http.Controllers.HttpParameterDescriptor)">
|
<summary>Gets the binding for a parameter.</summary>
|
<returns>The <see cref="T:System.Web.Http.Controllers.HttpParameterBinding" /> that contains the binding.</returns>
|
<param name="parameter">The parameter to bind.</param>
|
</member>
|
<member name="T:System.Web.Http.OData.IDelta">
|
<summary>Allows and tracks changes to an object.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.IDelta.Clear">
|
<summary>Clears the <see cref="T:System.Web.Http.OData.IDelta" />.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.IDelta.GetChangedPropertyNames">
|
<summary>Returns the properties that have been modified through this IDelta as an enumerable of property names.</summary>
|
<returns>Returns <see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
|
</member>
|
<member name="M:System.Web.Http.OData.IDelta.GetUnchangedPropertyNames">
|
<summary>Returns the properties that have not been modified through this IDelta as an enumerable of property names.</summary>
|
<returns>Returns <see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
|
</member>
|
<member name="M:System.Web.Http.OData.IDelta.TryGetPropertyType(System.String,System.Type@)">
|
<summary>Attempts to get the <see cref="T:System.Type" /> of the property called <paramref name="name" /> from the underlying entity.</summary>
|
<returns>Returns true if the property was found and false if not.</returns>
|
<param name="name">The name of the property.</param>
|
<param name="type">The type of the property.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.IDelta.TryGetPropertyValue(System.String,System.Object@)">
|
<summary>Attempts to get the value of the property called <paramref name="name" /> from the underlying entity.</summary>
|
<returns>Returns true if the property was found and false if not.</returns>
|
<param name="name">The name of the property</param>
|
<param name="value">The value of the property</param>
|
</member>
|
<member name="M:System.Web.Http.OData.IDelta.TrySetPropertyValue(System.String,System.Object)">
|
<summary>Attempts to set the property called <paramref name="name" /> to the <paramref name="value" /> specified.</summary>
|
<returns>Returns true if successful and false if not.</returns>
|
<param name="name">The name of the property.</param>
|
<param name="value">The new value of the property.</param>
|
</member>
|
<member name="T:System.Web.Http.OData.ODataActionParameters">
|
<summary>ActionPayload holds the Parameter names and values provided by a client in a POST request to invoke a particular Action. The Parameter values are stored in the dictionary keyed using the Parameter name.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.ODataActionParameters.#ctor"></member>
|
<member name="T:System.Web.Http.OData.ODataController">
|
<summary>Defines a base class for OData controllers that support writing and reading data using the OData formats.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.ODataController.#ctor"></member>
|
<member name="T:System.Web.Http.OData.ODataFormattingAttribute">
|
<summary>An attribute to be placed on controllers that enables the OData formatters.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.ODataFormattingAttribute.#ctor"></member>
|
<member name="M:System.Web.Http.OData.ODataFormattingAttribute.Initialize(System.Web.Http.Controllers.HttpControllerSettings,System.Web.Http.Controllers.HttpControllerDescriptor)">
|
<summary>Callback invoked to set per-controller overrides for this controllerDescriptor.</summary>
|
<param name="controllerSettings">The controller settings to initialize.</param>
|
<param name="controllerDescriptor">The controller descriptor. Note that the <see cref="T:System.Web.Http.Controllers.HttpControllerDescriptor" /> can be associated with the derived controller type given that <see cref="T:System.Web.Http.Controllers.IControllerConfiguration" /> is inherited.</param>
|
</member>
|
<member name="T:System.Web.Http.OData.ODataMetadataController">
|
<summary>Represents an <see cref="T:System.Web.Http.ApiController" /> for generating OData servicedoc and metadata document ($metadata).</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.ODataMetadataController.#ctor"></member>
|
<member name="M:System.Web.Http.OData.ODataMetadataController.GetMetadata">
|
<summary>Generates the OData $metadata document.</summary>
|
<returns>The <see cref="T:Microsoft.Data.Edm.IEdmModel" /> representing $metadata.</returns>
|
</member>
|
<member name="M:System.Web.Http.OData.ODataMetadataController.GetServiceDocument">
|
<summary>Generates the OData service document.</summary>
|
<returns>The service document for the service.</returns>
|
</member>
|
<member name="T:System.Web.Http.OData.ODataQueryContext">
|
<summary>This defines some context information used to perform query composition.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.ODataQueryContext.#ctor(Microsoft.Data.Edm.IEdmModel,System.Type)">
|
<summary>Constructs an instance of <see cref="T:System.Web.Http.OData.ODataQueryContext" /> with <see cref="T:Microsoft.Data.Edm.IEdmModel" /> and element CLR type.</summary>
|
<param name="model">The EdmModel that includes the <see cref="T:Microsoft.Data.Edm.IEdmType" /> corresponding to the given <paramref name="elementClrType" /> .</param>
|
<param name="elementClrType">The CLR type of the element of the collection being queried.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.ODataQueryContext.ElementClrType">
|
<summary>Gets the CLR type of the element.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.ODataQueryContext.ElementType">
|
<summary>Gets the <see cref="T:Microsoft.Data.Edm.IEdmType" /> of the element.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.ODataQueryContext.Model">
|
<summary>Gets the given <see cref="T:Microsoft.Data.Edm.IEdmModel" /> that contains the EntitySet.</summary>
|
</member>
|
<member name="T:System.Web.Http.OData.ODataQueryParameterBindingAttribute">
|
<summary>A <see cref="T:System.Web.Http.ParameterBindingAttribute" /> to bind parameters of type <see cref="T:System.Web.Http.OData.Query.ODataQueryOptions" /> to the OData query from the incoming request.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.ODataQueryParameterBindingAttribute.#ctor"></member>
|
<member name="M:System.Web.Http.OData.ODataQueryParameterBindingAttribute.GetBinding(System.Web.Http.Controllers.HttpParameterDescriptor)"></member>
|
<member name="T:System.Web.Http.OData.ODataRoutingAttribute">
|
<summary>Defines a controller-level attribute that can be used to enable OData action selection based on routing conventions.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.ODataRoutingAttribute.#ctor"></member>
|
<member name="M:System.Web.Http.OData.ODataRoutingAttribute.Initialize(System.Web.Http.Controllers.HttpControllerSettings,System.Web.Http.Controllers.HttpControllerDescriptor)">
|
<summary>Callback invoked to set per-controller overrides for this controllerDescriptor.</summary>
|
<param name="controllerSettings">The controller settings to initialize.</param>
|
<param name="controllerDescriptor">The controller descriptor. Note that the <see cref="T:System.Web.Http.Controllers.HttpControllerDescriptor" /> can be associated with the derived controller type given that <see cref="T:System.Web.Http.Controllers.IControllerConfiguration" /> is inherited.</param>
|
</member>
|
<member name="T:System.Web.Http.OData.PageResult">
|
<summary>Represents a feed of entities that includes additional information that OData formats support.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.PageResult.#ctor(System.Uri,System.Nullable{System.Int64})">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.PageResult" /> class.</summary>
|
<param name="nextPageLink">The link for the next page of items in the feed.</param>
|
<param name="count">The total count of items in the feed.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.PageResult.Count">
|
<summary>Gets the total count of items in the feed.</summary>
|
<returns>Returns <see cref="T:System.Int64" />.</returns>
|
</member>
|
<member name="P:System.Web.Http.OData.PageResult.NextPageLink">
|
<summary>Gets the link for the next page of items in the feed.</summary>
|
<returns>Returns <see cref="T:System.Uri" />.</returns>
|
</member>
|
<member name="T:System.Web.Http.OData.PageResult`1">
|
<summary>Represents a feed of entities that includes additional information that OData formats support.</summary>
|
<typeparam name="T"></typeparam>
|
</member>
|
<member name="M:System.Web.Http.OData.PageResult`1.#ctor(System.Collections.Generic.IEnumerable{`0},System.Uri,System.Nullable{System.Int64})">
|
<summary>Creates a partial set of results - used when server driven paging is enabled.</summary>
|
<param name="items">The subset of matching results that should be serialized in this page.</param>
|
<param name="nextPageLink">A link to the next page of matching results (if more exists).</param>
|
<param name="count">A total count of matching results so clients can know the number of matches on the server.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.PageResult`1.GetEnumerator">
|
<summary>Returns an enumerator that iterates through a collection.</summary>
|
<returns>An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the collection.</returns>
|
</member>
|
<member name="P:System.Web.Http.OData.PageResult`1.Items">
|
<summary>Gets the collection of entities for this feed.</summary>
|
<returns>Returns <see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
|
</member>
|
<member name="M:System.Web.Http.OData.PageResult`1.System#Collections#IEnumerable#GetEnumerator">
|
<summary>Returns an enumerator that iterates through a collection.</summary>
|
<returns>An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the collection.</returns>
|
</member>
|
<member name="T:System.Web.Http.OData.Builder.ActionConfiguration">
|
<summary> ActionConfiguration represents an OData action that you wish to expose via your service. ActionConfigurations are exposed via $metadata as a <FunctionImport /> element. </summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.ActionConfiguration.AddParameter(System.String,System.Web.Http.OData.Builder.IEdmTypeConfiguration)">
|
<summary> Adds a new non-binding parameter. </summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.ActionConfiguration.BindingParameter">
|
<summary> Get the bindingParameter. Null means the Action has no bindingParameter. </summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.ActionConfiguration.CollectionParameter``1(System.String)">
|
<summary> Adds a new non-binding collection parameter </summary>
|
<typeparam name="TElementType"></typeparam>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.ActionConfiguration.FollowsConventions">
|
<summary>Gets a value indicating whether links provided by <see cref="M:System.Web.Http.OData.Builder.ActionConfiguration.GetActionLink" /> follow OData conventions.</summary>
|
<returns>Returns <see cref="T:System.Boolean" />.</returns>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.ActionConfiguration.GetActionLink">
|
<summary> Retrieves the currently registered action link factory. </summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.ActionConfiguration.HasActionLink(System.Func{System.Web.Http.OData.EntityInstanceContext,System.Uri},System.Boolean)">
|
<summary>Register a factory that creates actions links.</summary>
|
<returns>Returns <see cref="T:System.Web.Http.OData.Builder.ActionConfiguration" />.</returns>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.ActionConfiguration.IsAlwaysBindable">
|
<summary> Whether this action can always be bound. For example, imagine a Watch action that can be bound to a Movie: it might not always be possible to Watch a movie, in which case IsAlwaysBindable would return false. </summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.ActionConfiguration.IsBindable"></member>
|
<member name="P:System.Web.Http.OData.Builder.ActionConfiguration.Kind"></member>
|
<member name="M:System.Web.Http.OData.Builder.ActionConfiguration.Parameter``1(System.String)">
|
<summary> Adds a new non-binding parameter </summary>
|
<typeparam name="TParameter"></typeparam>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.ActionConfiguration.Parameters"></member>
|
<member name="M:System.Web.Http.OData.Builder.ActionConfiguration.Returns``1">
|
<summary> Established the return type of the Action. Used when the return type is a single Primitive or ComplexType. </summary>
|
<typeparam name="TReturnType"></typeparam>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.ActionConfiguration.ReturnsCollection``1">
|
<summary> Establishes the return type of the Action Used when the return type is a collection of either Primitive or ComplexTypes. </summary>
|
<typeparam name="TReturnElementType"></typeparam>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.ActionConfiguration.ReturnsCollectionFromEntitySet``1(System.String)">
|
<summary> Sets the return type to a collection of EntityType instances. </summary>
|
<param name="entitySetName">The entitySetName which contains the returned EntityType instances</param>
|
<typeparam name="TElementEntityType">The type that is an EntityType</typeparam>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.ActionConfiguration.ReturnsFromEntitySet``1(System.String)">
|
<summary> Sets the return type to a single EntityType instance. </summary>
|
<param name="entitySetName">The entitySetName which contains the return EntityType instance</param>
|
<typeparam name="TEntityType">The type that is an EntityType</typeparam>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.ActionConfiguration.SetBindingParameter(System.String,System.Web.Http.OData.Builder.IEdmTypeConfiguration,System.Boolean)">
|
<summary> Specifies the bindingParameter name, type and whether it is alwaysBindable, use only if the Action "isBindable". </summary>
|
</member>
|
<member name="T:System.Web.Http.OData.Builder.ActionLinkBuilder">
|
<summary> ActionLinkBuilder can be used to annotate an Action. This is how formatters create links to invoke bound actions. </summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.ActionLinkBuilder.#ctor(System.Func{System.Web.Http.OData.EntityInstanceContext,System.Uri},System.Boolean)">
|
<summary>Create a new ActionLinkBuilder based on an actionLinkFactory.</summary>
|
<param name="actionLinkFactory">The actionLinkFactory this ActionLinkBuilder should use when building links.</param>
|
<param name="followsConventions">A value indicating whether the action link factory generates links that follow OData conventions.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.ActionLinkBuilder.BuildActionLink(System.Web.Http.OData.EntityInstanceContext)">
|
<summary>Builds the action link for the given entity.</summary>
|
<returns>The generated action link.</returns>
|
<param name="context">An instance context wrapping the entity instance.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.ActionLinkBuilder.CreateActionLinkFactory(System.Func{System.Web.Http.OData.EntityInstanceContext,System.Uri},System.Func{System.Web.Http.OData.EntityInstanceContext,System.Boolean})">
|
<summary> Creates an action link factory that builds an action link, but only when appropriate based on the expensiveAvailabilityCheck, and whether expensive checks should be made, which is deduced by looking at the EntityInstanceContext.SkipExpensiveActionAvailabilityChecks property. </summary>
|
<returns>The new action link factory.</returns>
|
<param name="baseFactory">The action link factory that actually builds links if all checks pass.</param>
|
<param name="expensiveAvailabilityCheck">The availability check function that is expensive but when called returns whether the action is available.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.ActionLinkBuilder.FollowsConventions">
|
<summary>Gets a boolean indicating whether the link factory follows OData conventions or not.</summary>
|
<returns>Returns <see cref="T:System.Boolean" />.</returns>
|
</member>
|
<member name="T:System.Web.Http.OData.Builder.BindingParameterConfiguration">
|
<summary> Represents a BindingParameter.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.BindingParameterConfiguration.#ctor(System.String,System.Web.Http.OData.Builder.IEdmTypeConfiguration,System.Boolean)">
|
<summary> Create a BindingParameterConfiguration </summary>
|
<param name="name">The name of the Binding Parameter</param>
|
<param name="parameterType">The type of the Binding Parameter</param>
|
<param name="alwaysBindable">Whether the action can always be bound to instances of the binding parameter.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.BindingParameterConfiguration.AlwaysBindable">
|
<summary> Indicates whether the BindingParameter is always bindable or not. For example some actions are always available some are only available at certain times or in certain states. </summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Builder.BindingParameterConfiguration.DefaultBindingParameterName">
|
<summary>The default parameter name for an action’s binding parameter.</summary>
|
</member>
|
<member name="T:System.Web.Http.OData.Builder.CollectionPropertyConfiguration">
|
<summary>CollectionPropertyConfiguration represents a CollectionProperty on either an EntityType or ComplexType.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.CollectionPropertyConfiguration.#ctor(System.Reflection.PropertyInfo,System.Web.Http.OData.Builder.StructuralTypeConfiguration)">
|
<summary>Constructs a CollectionPropertyConfiguration using the <paramref name="property" /> provided.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.CollectionPropertyConfiguration.ElementType">
|
<summary>Returns the type of Elements in the Collection</summary>
|
<returns>Returns <see cref="T:System.Type" />.</returns>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.CollectionPropertyConfiguration.IsOptional">
|
<summary>Sets the CollectionProperty to optional (i.e. nullable).</summary>
|
<returns>Returns <see cref="T:System.Web.Http.OData.Builder.CollectionPropertyConfiguration" />.</returns>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.CollectionPropertyConfiguration.IsRequired">
|
<summary>Sets the CollectionProperty to required (i.e. non-nullable).</summary>
|
<returns>Returns <see cref="T:System.Web.Http.OData.Builder.CollectionPropertyConfiguration" />.</returns>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.CollectionPropertyConfiguration.Kind">
|
<returns>Returns <see cref="T:System.Web.Http.OData.Builder.PropertyKind" />.</returns>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.CollectionPropertyConfiguration.RelatedClrType">
|
<returns>Returns <see cref="T:System.Type" />.</returns>
|
</member>
|
<member name="T:System.Web.Http.OData.Builder.CollectionTypeConfiguration">
|
<summary>Represents a Collection of some named type. For example, Collection(Namespace.Customer) or Collection(Namespace.Adress).</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.CollectionTypeConfiguration.#ctor(System.Web.Http.OData.Builder.IEdmTypeConfiguration,System.Type)">
|
<summary>Constructs a collection that contains elements of the specified ElementType and that is represented in CLR using the specified clrType.</summary>
|
<param name="elementType">The EdmTypeConfiguration of the elements in the collection</param>
|
<param name="clrType">The type of this collection when manifested in CLR.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.CollectionTypeConfiguration.ClrType">
|
<summary>Gets the CLR type associated with this collection type.</summary>
|
<returns>Returns <see cref="T:System.Type" />.</returns>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.CollectionTypeConfiguration.ElementType">
|
<summary>Gets the <see cref="T:System.Web.Http.OData.Builder.IEdmTypeConfiguration" /> of elements in this collection.</summary>
|
<returns>Returns <see cref="T:System.Web.Http.OData.Builder.IEdmTypeConfiguration" />.</returns>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.CollectionTypeConfiguration.FullName">
|
<summary>Gets the full name (including namespace) of this collection type.</summary>
|
<returns>Returns <see cref="T:System.String" />.</returns>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.CollectionTypeConfiguration.Kind">
|
<summary>Gets the kind of the EdmType. In this case, it is <see cref="F:Microsoft.Data.Edm.EdmTypeKind.Collection" />.</summary>
|
<returns>Returns <see cref="T:Microsoft.Data.Edm.EdmTypeKind" />.</returns>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.CollectionTypeConfiguration.ModelBuilder">
|
<summary>Gets the associated <see cref="T:System.Web.Http.OData.Builder.ODataModelBuilder" />.</summary>
|
<returns>Returns <see cref="T:System.Web.Http.OData.Builder.ODataModelBuilder" />.</returns>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.CollectionTypeConfiguration.Name">
|
<summary>Gets the name of this collection type.</summary>
|
<returns>Returns <see cref="T:System.String" />.</returns>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.CollectionTypeConfiguration.Namespace">
|
<summary>Gets the namespace of this collection type.</summary>
|
<returns>Returns <see cref="T:System.String" />.</returns>
|
</member>
|
<member name="T:System.Web.Http.OData.Builder.ComplexPropertyConfiguration">
|
<summary>Represents the configuration for a complex property of a structural type (an entity type or a complex type).</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.ComplexPropertyConfiguration.#ctor(System.Reflection.PropertyInfo,System.Web.Http.OData.Builder.StructuralTypeConfiguration)">
|
<summary>Instantiates a new instance of the <see cref="T:System.Web.Http.OData.Builder.ComplexPropertyConfiguration" /> class.</summary>
|
<param name="property">The property of the configuration.</param>
|
<param name="declaringType">The declaring type of the property.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.ComplexPropertyConfiguration.IsOptional">
|
<summary>Marks the current complex property as optional.</summary>
|
<returns>Returns itself so that multiple calls can be chained.</returns>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.ComplexPropertyConfiguration.IsRequired">
|
<summary>Marks the current complex property as required.</summary>
|
<returns>Returns itself so that multiple calls can be chained.</returns>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.ComplexPropertyConfiguration.Kind">
|
<returns>Returns <see cref="T:System.Web.Http.OData.Builder.PropertyKind" />.</returns>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.ComplexPropertyConfiguration.RelatedClrType">
|
<returns>Returns <see cref="T:System.Type" />.</returns>
|
</member>
|
<member name="T:System.Web.Http.OData.Builder.ComplexTypeConfiguration">
|
<summary>Allows configuration to be performed for a complex type in a model. A ComplexTypeConfiguration can be obtained by using the method <see cref="M:System.Web.Http.OData.Builder.ODataModelBuilder.ComplexType``1" /> .</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.ComplexTypeConfiguration.#ctor">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Builder.ComplexTypeConfiguration" /> class.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.ComplexTypeConfiguration.#ctor(System.Web.Http.OData.Builder.ODataModelBuilder,System.Type)">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Builder.ComplexTypeConfiguration" /> class.</summary>
|
<param name="modelBuilder">The <see cref="T:System.Web.Http.OData.Builder.ODataModelBuilder" /> being used.</param>
|
<param name="clrType">The backing CLR type for this entity type.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.ComplexTypeConfiguration.Kind">
|
<returns>Returns <see cref="T:Microsoft.Data.Edm.EdmTypeKind" />.</returns>
|
</member>
|
<member name="T:System.Web.Http.OData.Builder.ComplexTypeConfiguration`1">
|
<summary>Represents an <see cref="T:Microsoft.Data.Edm.IEdmComplexType" /> that can be built using <see cref="T:System.Web.Http.OData.Builder.ODataModelBuilder" />.</summary>
|
<typeparam name="TComplexType"></typeparam>
|
</member>
|
<member name="T:System.Web.Http.OData.Builder.EntityCollectionConfiguration`1">
|
<summary>EntityCollectionConfiguration represents a Collection of Entities. This class can be used to configure things that get bound to entities, like Actions bound to a collection.</summary>
|
<typeparam name="TEntityType">The EntityType that is the ElementType of the EntityCollection</typeparam>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntityCollectionConfiguration`1.Action(System.String)">
|
<summary>Creates a new Action that binds to Collection(EntityType).</summary>
|
<returns>An ActionConfiguration to allow further configuration of the Action.</returns>
|
<param name="name">The name of the Action</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntityCollectionConfiguration`1.TransientAction(System.String)">
|
<summary>Creates a new Action that sometimes binds to Collection(EntityType).</summary>
|
<returns>An ActionConfiguration to allow further configuration of the Action.</returns>
|
<param name="name">The name of the Action</param>
|
</member>
|
<member name="T:System.Web.Http.OData.Builder.EntitySetConfiguration">
|
<summary>Allows configuration to be performed for an entity set in a model. A <see cref="T:System.Web.Http.OData.Builder.EntitySetConfiguration" /> can be obtained by using the method <see cref="M:System.Web.Http.OData.Builder.ODataModelBuilder.EntitySet``1(System.String)" /> .</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration.#ctor">
|
<summary> Initializes a new instance of the <see cref="T:System.Web.Http.OData.Builder.EntitySetConfiguration" /> class.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration.#ctor(System.Web.Http.OData.Builder.ODataModelBuilder,System.Type,System.String)">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Builder.EntitySetConfiguration" /> class.</summary>
|
<param name="modelBuilder">The <see cref="T:System.Web.Http.OData.Builder.ODataModelBuilder" />.</param>
|
<param name="entityType">The CLR <see cref="T:System.Type" /> of the entity type contained in this entity set.</param>
|
<param name="name">The name of the entity set.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration.#ctor(System.Web.Http.OData.Builder.ODataModelBuilder,System.Web.Http.OData.Builder.EntityTypeConfiguration,System.String)">
|
<summary> Initializes a new instance of the <see cref="T:System.Web.Http.OData.Builder.EntitySetConfiguration" /> class.</summary>
|
<param name="modelBuilder">The <see cref="T:System.Web.Http.OData.Builder.ODataModelBuilder" />.</param>
|
<param name="entityType">The CLR <see cref="T:System.Type" /> of the entity type contained in this entity set.</param>
|
<param name="name">The name of the entity set.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration.AddBinding(System.Web.Http.OData.Builder.NavigationPropertyConfiguration,System.Web.Http.OData.Builder.EntitySetConfiguration)">
|
<summary>Binds the given navigation property to the target entity set.</summary>
|
<returns>The <see cref="T:System.Web.Http.OData.Builder.NavigationPropertyBindingConfiguration" /> so that it can be further configured.</returns>
|
<param name="navigationConfiguration">The navigation property.</param>
|
<param name="targetEntitySet">The target entity set.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.EntitySetConfiguration.Bindings">
|
<summary>Gets the navigation targets of this entity set.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.EntitySetConfiguration.ClrType">
|
<summary>Gets the backing clr type for the entity type contained in this entity set.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.EntitySetConfiguration.EntityType">
|
<summary>Gets the entity type contained in this entity set.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration.FindBinding(System.String)">
|
<summary>Gets the <see cref="T:System.Web.Http.OData.Builder.NavigationPropertyBindingConfiguration" /> for the navigation property with the given name.</summary>
|
<returns>The <see cref="T:System.Web.Http.OData.Builder.NavigationPropertyBindingConfiguration" />.</returns>
|
<param name="propertyName">The name of the navigation property.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration.FindBinding(System.Web.Http.OData.Builder.NavigationPropertyConfiguration)">
|
<summary>Finds the binding for the given navigation property and tries to create it if it does not exist.</summary>
|
<returns>The <see cref="T:System.Web.Http.OData.Builder.NavigationPropertyBindingConfiguration" /> so that it can be further configured.</returns>
|
<param name="navigationConfiguration">The navigation property.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration.FindBinding(System.Web.Http.OData.Builder.NavigationPropertyConfiguration,System.Boolean)">
|
<summary>Finds the binding for the given navigation property.</summary>
|
<returns>The <see cref="T:System.Web.Http.OData.Builder.NavigationPropertyBindingConfiguration" /> so that it can be further configured.</returns>
|
<param name="navigationConfiguration">The navigation property.</param>
|
<param name="autoCreate">Tells whether the binding should be auto created if it does not exist.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration.GetEditLink">
|
<summary>Gets the builder used to generate edit links for entries from this entity set.</summary>
|
<returns>The link builder.</returns>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration.GetFeedSelfLink">
|
<summary>Gets the builder used to generate self links for feeds for this entity set.</summary>
|
<returns>The link builder.</returns>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration.GetIdLink">
|
<summary>Gets the builder used to generate ID for entries from this entity set.</summary>
|
<returns>The builder.</returns>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration.GetNavigationPropertyLink(System.Web.Http.OData.Builder.NavigationPropertyConfiguration)">
|
<summary>Gets the builder used to generate navigation link for the given navigation property for entries from this entity set.</summary>
|
<returns>The link builder.</returns>
|
<param name="navigationProperty">The navigation property.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration.GetReadLink">
|
<summary>Gets the builder used to generate read links for entries from this entity set.</summary>
|
<returns>The link builder.</returns>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration.GetUrl">
|
<summary>Gets the entity set URL.</summary>
|
<returns>The entity set URL.</returns>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration.HasEditLink(System.Web.Http.OData.Builder.SelfLinkBuilder{System.Uri})">
|
<summary>Configures the edit link for the entities from this entity set.</summary>
|
<returns>Returns itself so that multiple calls can be chained.</returns>
|
<param name="editLinkBuilder">The builder used to generate the edit link.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration.HasFeedSelfLink(System.Func{System.Web.Http.OData.FeedContext,System.Uri})">
|
<summary>Adds a self link to the feed.</summary>
|
<returns>The entity set configuration currently being configured.</returns>
|
<param name="feedSelfLinkFactory">The builder used to generate the link URL.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration.HasIdLink(System.Web.Http.OData.Builder.SelfLinkBuilder{System.String})">
|
<summary>Configures the ID for the entities from this entity set.</summary>
|
<returns>Returns itself so that multiple calls can be chained.</returns>
|
<param name="idLinkBuilder">The builder used to generate the ID.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration.HasNavigationPropertiesLink(System.Collections.Generic.IEnumerable{System.Web.Http.OData.Builder.NavigationPropertyConfiguration},System.Web.Http.OData.Builder.NavigationLinkBuilder)">
|
<summary>Configures the navigation link for the given navigation properties for entities from this entity set.</summary>
|
<returns>Returns itself so that multiple calls can be chained.</returns>
|
<param name="navigationProperties">The navigation properties for which the navigation link is being generated.</param>
|
<param name="navigationLinkBuilder">The builder used to generate the navigation link.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration.HasNavigationPropertyLink(System.Web.Http.OData.Builder.NavigationPropertyConfiguration,System.Web.Http.OData.Builder.NavigationLinkBuilder)">
|
<summary>Configures the navigation link for the given navigation property for entities from this entity set.</summary>
|
<returns>Returns itself so that multiple calls can be chained.</returns>
|
<param name="navigationProperty">The navigation property for which the navigation link is being generated.</param>
|
<param name="navigationLinkBuilder">The builder used to generate the navigation link.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration.HasReadLink(System.Web.Http.OData.Builder.SelfLinkBuilder{System.Uri})">
|
<summary>Configures the read link for the entities from this entity set.</summary>
|
<returns>Returns itself so that multiple calls can be chained.</returns>
|
<param name="readLinkBuilder">The builder used to generate the read link.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration.HasUrl(System.String)">
|
<summary>Configures the entity set URL.</summary>
|
<returns>Returns itself so that multiple calls can be chained.</returns>
|
<param name="url">The entity set URL.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.EntitySetConfiguration.Name">
|
<summary>Gets the name of this entity set.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration.RemoveBinding(System.Web.Http.OData.Builder.NavigationPropertyConfiguration)">
|
<summary>Removes the binding for the given navigation property.</summary>
|
<param name="navigationConfiguration">The navigation property</param>
|
</member>
|
<member name="T:System.Web.Http.OData.Builder.EntitySetConfiguration`1">
|
<summary>Represents an <see cref="T:Microsoft.Data.Edm.IEdmEntitySet" /> that can be built using <see cref="T:System.Web.Http.OData.Builder.ODataModelBuilder" />.</summary>
|
<typeparam name="TEntityType">The element type of the entity set.</typeparam>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.EntitySetConfiguration`1.EntityType">
|
<summary>Gets the entity type contained in this entity set.</summary>
|
<returns>Returns <see cref="T:System.Web.Http.OData.Builder.EntityTypeConfiguration`1" />.</returns>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration`1.FindBinding(System.String)">
|
<summary>Finds the <see cref="T:System.Web.Http.OData.Builder.NavigationPropertyBindingConfiguration" /> for the navigation property with the given name.</summary>
|
<returns>The binding, if found; otherwise, null.</returns>
|
<param name="propertyName">The name of the navigation property.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration`1.FindBinding(System.Web.Http.OData.Builder.NavigationPropertyConfiguration)">
|
<summary>Finds the <see cref="T:System.Web.Http.OData.Builder.NavigationPropertyBindingConfiguration" /> for the navigation property or creates it if it does not exist.</summary>
|
<returns>The binding if found; else the created binding.</returns>
|
<param name="navigationConfiguration">The navigation property.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration`1.FindBinding(System.Web.Http.OData.Builder.NavigationPropertyConfiguration,System.Boolean)">
|
<summary>Finds the <see cref="T:System.Web.Http.OData.Builder.NavigationPropertyBindingConfiguration" /> for the given navigation property.</summary>
|
<returns>The binding if found.</returns>
|
<param name="navigationConfiguration">The navigation property.</param>
|
<param name="autoCreate">Represents a value specifying if the binding should be created if it is not found.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration`1.HasEditLink(System.Func{System.Web.Http.OData.EntityInstanceContext{`0},System.String},System.Boolean)">
|
<summary>Configures the edit link for the entities from this entity set.</summary>
|
<param name="editLinkFactory">The factory used to generate the edit link.</param>
|
<param name="followsConventions">Represents a value indicating whether the factory follows OData edit link conventions or not.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration`1.HasEditLink(System.Func{System.Web.Http.OData.EntityInstanceContext{`0},System.Uri},System.Boolean)">
|
<param name="editLinkFactory">The factory used to generate the edit link.</param>
|
<param name="followsConventions">Represents a value indicating whether the factory follows OData edit link conventions or not.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration`1.HasFeedSelfLink(System.Func{System.Web.Http.OData.FeedContext,System.String})">
|
<summary> Adds a self link to the feed.</summary>
|
<param name="feedSelfLinkFactory">The builder used to generate the link URL.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration`1.HasFeedSelfLink(System.Func{System.Web.Http.OData.FeedContext,System.Uri})">
|
<summary> Adds a self link to the feed.</summary>
|
<param name="feedSelfLinkFactory">The builder used to generate the link URL.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration`1.HasIdLink(System.Func{System.Web.Http.OData.EntityInstanceContext{`0},System.String},System.Boolean)">
|
<summary>Configures the ID link for the entities from this entity set.</summary>
|
<param name="idLinkFactory">The factory used to generate the ID link.</param>
|
<param name="followsConventions">
|
<see cref="true" /> if the factory follows OData ID link conventions; otherwise, <see cref="false" /> .</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration`1.HasManyBinding``2(System.Linq.Expressions.Expression{System.Func{``1,System.Collections.Generic.IEnumerable{``0}}},System.String)">
|
<summary>Configures a many relationship from this entity type and binds the corresponding navigation property to the given entity set.</summary>
|
<returns>A configuration object that can be used to further configure the relationship.</returns>
|
<param name="navigationExpression">A lambda expression representing the navigation property for the relationship.For example, in C# t => t.MyProperty and in Visual Basic .NET Function(t) t.MyProperty.</param>
|
<param name="entitySetName">The target entity set name for the binding. It will be created if it does not exist.</param>
|
<typeparam name="TTargetType">The target entity set type.</typeparam>
|
<typeparam name="TDerivedEntityType">The target entity type.</typeparam>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration`1.HasManyBinding``2(System.Linq.Expressions.Expression{System.Func{``1,System.Collections.Generic.IEnumerable{``0}}},System.Web.Http.OData.Builder.EntitySetConfiguration{``0})">
|
<summary>Configures a many relationship from this entity type and binds the corresponding navigation property to the given entity set.</summary>
|
<returns>A configuration object that can be used to further configure the relationship.</returns>
|
<param name="navigationExpression">A lambda expression representing the navigation property for the relationship.For example, in C# t => t.MyProperty and in Visual Basic .NET Function(t) t.MyProperty.</param>
|
<param name="targetSet">The target entity set name for the binding. It will be created if it does not exist.</param>
|
<typeparam name="TTargetType">The target entity set type.</typeparam>
|
<typeparam name="TDerivedEntityType">The target entity type.</typeparam>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration`1.HasManyBinding``1(System.Linq.Expressions.Expression{System.Func{`0,System.Collections.Generic.IEnumerable{``0}}},System.String)">
|
<summary>Configures a many relationship from this entity type and binds the corresponding navigation property to the given entity set.</summary>
|
<returns>A configuration object that can be used to further configure the relationship.</returns>
|
<param name="navigationExpression">A lambda expression representing the navigation property for the relationship.For example, in C# t => t.MyProperty and in Visual Basic .NET Function(t) t.MyProperty.</param>
|
<param name="entitySetName">The target entity set name for the binding. It will be created if it does not exist.</param>
|
<typeparam name="TTargetType">The target entity set type.</typeparam>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration`1.HasManyBinding``1(System.Linq.Expressions.Expression{System.Func{`0,System.Collections.Generic.IEnumerable{``0}}},System.Web.Http.OData.Builder.EntitySetConfiguration{``0})">
|
<summary>Configures a many relationship from this entity type and binds the corresponding navigation property to the given entity set.</summary>
|
<returns>A configuration object that can be used to further configure the relationship.</returns>
|
<param name="navigationExpression">A lambda expression representing the navigation property for the relationship.For example, in C# t => t.MyProperty and in Visual Basic .NET Function(t) t.MyProperty.</param>
|
<param name="targetSet">The target entity set name for the binding. It will be created if it does not exist.</param>
|
<typeparam name="TTargetType">The target entity set type.</typeparam>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration`1.HasNavigationPropertiesLink(System.Collections.Generic.IEnumerable{System.Web.Http.OData.Builder.NavigationPropertyConfiguration},System.Func{System.Web.Http.OData.EntityInstanceContext{`0},Microsoft.Data.Edm.IEdmNavigationProperty,System.Uri},System.Boolean)">
|
<summary>Configures the navigation link for the given navigation properties for entities from this entity set.</summary>
|
<param name="navigationProperties">The navigation properties for which the navigation link is being generated.</param>
|
<param name="navigationLinkFactory">The factory used to generate the navigation link.</param>
|
<param name="followsConventions">Represents a value indicating whether the factory follows OData navigation link conventions or not.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration`1.HasNavigationPropertyLink(System.Web.Http.OData.Builder.NavigationPropertyConfiguration,System.Func{System.Web.Http.OData.EntityInstanceContext{`0},Microsoft.Data.Edm.IEdmNavigationProperty,System.Uri},System.Boolean)">
|
<summary>Configures the navigation link for the given navigation property for entities from this entity set.</summary>
|
<param name="navigationProperty">The navigation property for which the navigation link is being generated.</param>
|
<param name="navigationLinkFactory">The factory used to generate the navigation link.</param>
|
<param name="followsConventions">Represents a value indicating whether the factory follows OData navigation link conventions or not.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration`1.HasOptionalBinding``2(System.Linq.Expressions.Expression{System.Func{``1,``0}},System.String)">
|
<summary>Configures an optional relationship from this entity type and binds the corresponding navigation property to the given entity set.</summary>
|
<returns>A configuration object that can be used to further configure the relationship.</returns>
|
<param name="navigationExpression">A lambda expression representing the navigation property for the relationship.For example, in C# t => t.MyProperty and in Visual Basic .NET Function(t) t.MyProperty.</param>
|
<param name="entitySetName">The target entity set name for the binding.</param>
|
<typeparam name="TTargetType">The target entity set type.</typeparam>
|
<typeparam name="TDerivedEntityType">The target entity type.</typeparam>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration`1.HasOptionalBinding``2(System.Linq.Expressions.Expression{System.Func{``1,``0}},System.Web.Http.OData.Builder.EntitySetConfiguration{``0})">
|
<summary>Configures an optional relationship from this entity type and binds the corresponding navigation property to the given entity set.</summary>
|
<returns>A configuration object that can be used to further configure the relationship.</returns>
|
<param name="navigationExpression">A lambda expression representing the navigation property for the relationship.For example, in C# t => t.MyProperty and in Visual Basic .NET Function(t) t.MyProperty.</param>
|
<param name="targetSet">The target entity set for the binding.</param>
|
<typeparam name="TTargetType">The target entity set type.</typeparam>
|
<typeparam name="TDerivedEntityType">The target entity type.</typeparam>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration`1.HasOptionalBinding``1(System.Linq.Expressions.Expression{System.Func{`0,``0}},System.String)">
|
<summary>Configures an optional relationship from this entity type and binds the corresponding navigation property to the given entity set.</summary>
|
<returns>A configuration object that can be used to further configure the relationship.</returns>
|
<param name="navigationExpression">A lambda expression representing the navigation property for the relationship.For example, in C# t => t.MyProperty and in Visual Basic .NET Function(t) t.MyProperty.</param>
|
<param name="entitySetName">The target entity set name for the binding.</param>
|
<typeparam name="TTargetType">The target entity set type.</typeparam>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration`1.HasOptionalBinding``1(System.Linq.Expressions.Expression{System.Func{`0,``0}},System.Web.Http.OData.Builder.EntitySetConfiguration{``0})">
|
<summary>Configures an optional relationship from this entity type and binds the corresponding navigation property to the given entity set.</summary>
|
<returns>A configuration object that can be used to further configure the relationship.</returns>
|
<param name="navigationExpression">A lambda expression representing the navigation property for the relationship.For example, in C# t => t.MyProperty and in Visual Basic .NET Function(t) t.MyProperty.</param>
|
<param name="targetSet">The target entity set for the binding.</param>
|
<typeparam name="TTargetType">The target entity set type.</typeparam>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration`1.HasReadLink(System.Func{System.Web.Http.OData.EntityInstanceContext{`0},System.String},System.Boolean)">
|
<summary>Configures the read link for the entities from this entity set.</summary>
|
<param name="readLinkFactory">The builder used to generate the read link.</param>
|
<param name="followsConventions">Represents a value indicating whether the factory follows OData conventions or not.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration`1.HasReadLink(System.Func{System.Web.Http.OData.EntityInstanceContext{`0},System.Uri},System.Boolean)">
|
<summary>Configures the read link for the entities from this entity set.</summary>
|
<param name="readLinkFactory">The builder used to generate the read link.</param>
|
<param name="followsConventions">Represents a value indicating whether the factory follows OData conventions or not.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration`1.HasRequiredBinding``2(System.Linq.Expressions.Expression{System.Func{``1,``0}},System.String)">
|
<summary>Configures a required relationship from this entity type and binds the corresponding navigation property to the given entity set.</summary>
|
<returns>A configuration object that can be used to further configure the relationship.</returns>
|
<param name="navigationExpression">A lambda expression representing the navigation property for the relationship.For example, in C# t => t.MyProperty and in Visual Basic .NET Function(t) t.MyProperty.</param>
|
<typeparam name="TTargetType">The target entity set type.</typeparam>
|
<typeparam name="TDerivedEntityType">The target entity type.</typeparam>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration`1.HasRequiredBinding``2(System.Linq.Expressions.Expression{System.Func{``1,``0}},System.Web.Http.OData.Builder.EntitySetConfiguration{``0})">
|
<summary>Configures a required relationship from this entity type and binds the corresponding navigation property to the given entity set.</summary>
|
<returns>A configuration object that can be used to further configure the relationship.</returns>
|
<param name="navigationExpression">A lambda expression representing the navigation property for the relationship.For example, in C# t => t.MyProperty and in Visual Basic .NET Function(t) t.MyProperty.</param>
|
<param name="targetSet">The target entity set for the binding.</param>
|
<typeparam name="TTargetType">The target entity set type.</typeparam>
|
<typeparam name="TDerivedEntityType">The target entity type.</typeparam>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration`1.HasRequiredBinding``1(System.Linq.Expressions.Expression{System.Func{`0,``0}},System.String)">
|
<summary>Configures a required relationship from this entity type and binds the corresponding navigation property to the given entity set.</summary>
|
<returns>A configuration object that can be used to further configure the relationship.</returns>
|
<param name="navigationExpression">A lambda expression representing the navigation property for the relationship.For example, in C# t => t.MyProperty and in Visual Basic .NET Function(t) t.MyProperty.</param>
|
<param name="entitySetName">The target entity set name for the binding.</param>
|
<typeparam name="TTargetType">The target entity set type.</typeparam>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntitySetConfiguration`1.HasRequiredBinding``1(System.Linq.Expressions.Expression{System.Func{`0,``0}},System.Web.Http.OData.Builder.EntitySetConfiguration{``0})">
|
<summary>Configures a required relationship from this entity type and binds the corresponding navigation property to the given entity set.</summary>
|
<returns>A configuration object that can be used to further configure the relationship.</returns>
|
<param name="navigationExpression">A lambda expression representing the navigation property for the relationship.For example, in C# t => t.MyProperty and in Visual Basic .NET Function(t) t.MyProperty.</param>
|
<param name="targetSet">The target entity set for the binding.</param>
|
<typeparam name="TTargetType">The target entity set type.</typeparam>
|
</member>
|
<member name="T:System.Web.Http.OData.Builder.EntityTypeConfiguration">
|
<summary>Represents an <see cref="T:Microsoft.Data.Edm.IEdmEntityType" /> that can be built using <see cref="T:System.Web.Http.OData.Builder.ODataModelBuilder" /> .</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntityTypeConfiguration.#ctor">
|
<summary> Initializes a new instance of the <see cref="T:System.Web.Http.OData.Builder.EntityTypeConfiguration" /> class.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntityTypeConfiguration.#ctor(System.Web.Http.OData.Builder.ODataModelBuilder,System.Type)">
|
<summary> Initializes a new instance of the <see cref="T:System.Web.Http.OData.Builder.EntityTypeConfiguration" /> class.</summary>
|
<param name="modelBuilder">The <see cref="T:System.Web.Http.OData.Builder.ODataModelBuilder" /> being used.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntityTypeConfiguration.Abstract">
|
<summary>Marks this entity type as abstract.</summary>
|
<returns>Returns itself so that multiple calls can be chained.</returns>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntityTypeConfiguration.AddCollectionProperty(System.Reflection.PropertyInfo)">
|
<summary>Adds a new EDM collection property to this entity type.</summary>
|
<returns>Returns the <see cref="T:System.Web.Http.OData.Builder.CollectionPropertyConfiguration" /> of the added property.</returns>
|
<param name="propertyInfo">The backing CLR property.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntityTypeConfiguration.AddComplexProperty(System.Reflection.PropertyInfo)">
|
<summary>Adds a new EDM complex property to this entity type.</summary>
|
<returns>Returns the <see cref="T:System.Web.Http.OData.Builder.ComplexPropertyConfiguration" /> of the added property.</returns>
|
<param name="propertyInfo">The backing CLR property.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntityTypeConfiguration.AddNavigationProperty(System.Reflection.PropertyInfo,Microsoft.Data.Edm.EdmMultiplicity)">
|
<summary>Adds a new EDM navigation property to this entity type.</summary>
|
<returns>Returns the <see cref="T:System.Web.Http.OData.Builder.NavigationPropertyConfiguration" /> of the added property.</returns>
|
<param name="navigationProperty">The backing CLR property.</param>
|
<param name="multiplicity">The <see cref="T:Microsoft.Data.Edm.EdmMultiplicity" /> of the navigation property.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntityTypeConfiguration.AddProperty(System.Reflection.PropertyInfo)">
|
<summary>Adds a new EDM primitive property to this entity type.</summary>
|
<returns>Returns the <see cref="T:System.Web.Http.OData.Builder.PrimitivePropertyConfiguration" /> of the added property.</returns>
|
<param name="propertyInfo">The backing CLR property.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.EntityTypeConfiguration.BaseType">
|
<summary>Gets or sets the base type of this entity type.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.EntityTypeConfiguration.BaseTypeConfigured">
|
<summary>Gets a value that represents whether the base type is explicitly configured or inferred.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntityTypeConfiguration.DerivesFrom(System.Web.Http.OData.Builder.EntityTypeConfiguration)">
|
<summary>Sets the base type of this entity type.</summary>
|
<returns>Returns itself so that multiple calls can be chained.</returns>
|
<param name="baseType">The base entity type.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntityTypeConfiguration.DerivesFromNothing">
|
<summary>Sets the base type of this entity type to null meaning that this entity type does not derive from anything.</summary>
|
<returns>Returns itself so that multiple calls can be chained.</returns>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntityTypeConfiguration.HasKey(System.Reflection.PropertyInfo)">
|
<summary>Configures the key property(s) for this entity type.</summary>
|
<returns>Returns itself so that multiple calls can be chained.</returns>
|
<param name="keyProperty">The property to be added to the key properties of this entity type.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.EntityTypeConfiguration.IsAbstract">
|
<summary>Gets or sets a value indicating whether this type is abstract.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.EntityTypeConfiguration.Keys">
|
<summary>Gets the collection of keys for this entity type.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.EntityTypeConfiguration.Kind">
|
<summary>Gets the <see cref="T:Microsoft.Data.Edm.EdmTypeKind" /> of this <see cref="T:System.Web.Http.OData.Builder.IEdmTypeConfiguration" /></summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.EntityTypeConfiguration.NavigationProperties">
|
<summary>Gets the collection of <see cref="T:System.Web.Http.OData.Builder.NavigationPropertyConfiguration" /> of this entity type.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntityTypeConfiguration.RemoveKey(System.Web.Http.OData.Builder.PrimitivePropertyConfiguration)">
|
<summary>Removes the property from the entity keys collection.</summary>
|
<param name="keyProperty">The key to be removed.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntityTypeConfiguration.RemoveProperty(System.Reflection.PropertyInfo)">
|
<summary>Removes the property from the entity.</summary>
|
<param name="propertyInfo">The <see cref="T:System.Reflection.PropertyInfo" /> of the property to be removed.</param>
|
</member>
|
<member name="T:System.Web.Http.OData.Builder.EntityTypeConfiguration`1">
|
<summary>Represents an <see cref="T:Microsoft.Data.Edm.IEdmEntityType" /> that can be built using <see cref="T:System.Web.Http.OData.Builder.ODataModelBuilder" /> .</summary>
|
<typeparam name="TEntityType">The backing CLR type for this <see cref="T:Microsoft.Data.Edm.IEdmEntityType" /> .</typeparam>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntityTypeConfiguration`1.Abstract">
|
<summary>Marks this entity type as abstract.</summary>
|
<returns>Returns itself so that multiple calls can be chained.</returns>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntityTypeConfiguration`1.Action(System.String)">
|
<summary>Create an Action that binds to this EntityType.</summary>
|
<returns>The ActionConfiguration to allow further configuration of the new Action.</returns>
|
<param name="name">The name of the action.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.EntityTypeConfiguration`1.BaseType">
|
<summary>Gets the base type of this entity type.</summary>
|
<returns>Returns <see cref="T:System.Web.Http.OData.Builder.EntityTypeConfiguration" />.</returns>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.EntityTypeConfiguration`1.Collection">
|
<summary>Used to access a Collection of Entities throw which you can configure actions that are bindable to EntityCollections.</summary>
|
<returns>Returns <see cref="T:System.Web.Http.OData.Builder.EntityCollectionConfiguration`1" />.</returns>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntityTypeConfiguration`1.DerivesFrom``1">
|
<summary>Sets the base type of this entity type.</summary>
|
<returns>Returns itself so that multiple calls can be chained.</returns>
|
<typeparam name="TBaseType">The base entity type.</typeparam>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntityTypeConfiguration`1.DerivesFromNothing">
|
<summary>Sets the base type of this entity type to null meaning that this entity type does not derive from anything.</summary>
|
<returns>Returns itself so that multiple calls can be chained.</returns>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntityTypeConfiguration`1.HasKey``1(System.Linq.Expressions.Expression{System.Func{`0,``0}})">
|
<summary>Configures the key property(s) for this entity type.</summary>
|
<returns>Returns itself so that multiple calls can be chained.</returns>
|
<param name="keyDefinitionExpression">A lambda expression representing the property to be used as the primary key. For example, in C# t =&gt; t.Id and in Visual Basic .Net Function(t) t.Id.</param>
|
<typeparam name="TKey">The type of key.</typeparam>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntityTypeConfiguration`1.HasMany``1(System.Linq.Expressions.Expression{System.Func{`0,System.Collections.Generic.IEnumerable{``0}}})">
|
<summary>Configures a many relationship from this entity type.</summary>
|
<returns>A configuration object that can be used to further configure the relationship.</returns>
|
<param name="navigationPropertyExpression">A lambda expression representing the navigation property for the relationship. For example, in C# t => t.MyProperty and in Visual Basic .NET Function(t) t.MyProperty .</param>
|
<typeparam name="TTargetEntity">The type of the entity at the other end of the relationship.</typeparam>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntityTypeConfiguration`1.HasOptional``1(System.Linq.Expressions.Expression{System.Func{`0,``0}})">
|
<summary>Configures an optional relationship from this entity type.</summary>
|
<returns>A configuration object that can be used to further configure the relationship.</returns>
|
<param name="navigationPropertyExpression">A lambda expression representing the navigation property for the relationship. For example, in C# t => t.MyProperty and in Visual Basic .NET Function(t) t.MyProperty .</param>
|
<typeparam name="TTargetEntity">The type of the entity at the other end of the relationship.</typeparam>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntityTypeConfiguration`1.HasRequired``1(System.Linq.Expressions.Expression{System.Func{`0,``0}})">
|
<summary>Configures a required relationship from this entity type.</summary>
|
<returns>A configuration object that can be used to further configure the relationship.</returns>
|
<param name="navigationPropertyExpression">A lambda expression representing the navigation property for the relationship. For example, in C# t => t.MyProperty and in Visual Basic .NET Function(t) t.MyProperty .</param>
|
<typeparam name="TTargetEntity">The type of the entity at the other end of the relationship.</typeparam>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.EntityTypeConfiguration`1.NavigationProperties">
|
<summary>Gets the collection of <see cref="T:System.Web.Http.OData.Builder.NavigationPropertyConfiguration" /> of this entity type.</summary>
|
<returns>Returns <see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.EntityTypeConfiguration`1.TransientAction(System.String)">
|
<summary>Create an Action that sometimes binds to this EntityType</summary>
|
<returns>The ActionConfiguration to allow further configuration of the new 'transient' Action.</returns>
|
<param name="name">The name of the action.</param>
|
</member>
|
<member name="T:System.Web.Http.OData.Builder.IEdmTypeConfiguration">
|
<summary>Represents an EdmType.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.IEdmTypeConfiguration.ClrType">
|
<summary>The CLR type associated with the EdmType.</summary>
|
<returns>Returns <see cref="T:System.Type" />.</returns>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.IEdmTypeConfiguration.FullName">
|
<summary>The full name (including namespace) of the EdmType.</summary>
|
<returns>Returns <see cref="T:System.String" />.</returns>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.IEdmTypeConfiguration.Kind">
|
<summary>The kind of the EdmType. Examples include EntityType, ComplexType, PrimitiveType, CollectionType.</summary>
|
<returns>Returns <see cref="T:Microsoft.Data.Edm.EdmTypeKind" />.</returns>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.IEdmTypeConfiguration.ModelBuilder">
|
<summary>The ODataModelBuilder used to create this IEdmType.</summary>
|
<returns>Returns <see cref="T:System.Web.Http.OData.Builder.ODataModelBuilder" />.</returns>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.IEdmTypeConfiguration.Name">
|
<summary>The name of the EdmType.</summary>
|
<returns>Returns <see cref="T:System.String" />.</returns>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.IEdmTypeConfiguration.Namespace">
|
<summary>The namespace of the EdmType.</summary>
|
<returns>Returns <see cref="T:System.String" />.</returns>
|
</member>
|
<member name="T:System.Web.Http.OData.Builder.NavigationLinkBuilder">
|
<summary>Encapsulates a navigation link factory and whether the link factory follows conventions or not.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.NavigationLinkBuilder.#ctor(System.Func{System.Web.Http.OData.EntityInstanceContext,Microsoft.Data.Edm.IEdmNavigationProperty,System.Uri},System.Boolean)">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Builder.NavigationLinkBuilder" /> class.</summary>
|
<param name="navigationLinkFactory">The navigation link factory for creating navigation links.</param>
|
<param name="followsConventions">Represents whether this factory follows OData conventions or not.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.NavigationLinkBuilder.Factory">
|
<summary>Gets the navigation link factory for creating navigation links.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.NavigationLinkBuilder.FollowsConventions">
|
<summary>Gets a value representing whether this factory follows OData conventions or not.</summary>
|
</member>
|
<member name="T:System.Web.Http.OData.Builder.NavigationPropertyBindingConfiguration">
|
<summary>Used to configure the binding for a navigation property for an entity set. This configuration functionality is exposed by the model builder Fluent API, see <see cref="T:System.Web.Http.OData.Builder.ODataModelBuilder" />.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.NavigationPropertyBindingConfiguration.#ctor(System.Web.Http.OData.Builder.NavigationPropertyConfiguration,System.Web.Http.OData.Builder.EntitySetConfiguration)">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Builder.NavigationPropertyBindingConfiguration" /> class.</summary>
|
<param name="navigationProperty">The navigation property for the binding.</param>
|
<param name="entitySet">The target entity set of the binding.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.NavigationPropertyBindingConfiguration.EntitySet">
|
<summary>Gets the target entity set of the binding.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.NavigationPropertyBindingConfiguration.NavigationProperty">
|
<summary>Gets the navigation property of the binding.</summary>
|
</member>
|
<member name="T:System.Web.Http.OData.Builder.NavigationPropertyConfiguration">
|
<summary>Represents the configuration for a navigation property of an entity type.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.NavigationPropertyConfiguration.#ctor(System.Reflection.PropertyInfo,Microsoft.Data.Edm.EdmMultiplicity,System.Web.Http.OData.Builder.EntityTypeConfiguration)">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Builder.NavigationPropertyConfiguration" /> class.</summary>
|
<param name="property">The backing CLR property.</param>
|
<param name="multiplicity">The <see cref="T:Microsoft.Data.Edm.EdmMultiplicity" /> .</param>
|
<param name="declaringType">The declaring entity type.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.NavigationPropertyConfiguration.DeclaringEntityType">
|
<summary>Gets the declaring entity type.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.NavigationPropertyConfiguration.Kind">
|
<summary>Gets the <see cref="T:System.Web.Http.OData.Builder.PropertyKind" /> of this property.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.NavigationPropertyConfiguration.Multiplicity">
|
<summary>Gets the <see cref="T:Microsoft.Data.Edm.EdmMultiplicity" /> of this navigation property.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.NavigationPropertyConfiguration.Optional">
|
<summary>Marks the navigation property as optional.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.NavigationPropertyConfiguration.RelatedClrType">
|
<summary>Gets the backing CLR type of this property type.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.NavigationPropertyConfiguration.Required">
|
<summary>Marks the navigation property as required.</summary>
|
</member>
|
<member name="T:System.Web.Http.OData.Builder.NonbindingParameterConfiguration">
|
<summary> Represents a non-binding procedure parameter. Non-binding parameters are provided in the POST body for Actions Non-binding parameters are provided in 3 ways for Functions - ~/.../Function(p1=value) - ~/.../Function(p1=@x)?@x=value - ~/.../Function?p1=value (only allowed if the Function is the last url path segment). </summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.NonbindingParameterConfiguration.#ctor(System.String,System.Web.Http.OData.Builder.IEdmTypeConfiguration)">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Builder.NonbindingParameterConfiguration" /> class.</summary>
|
<param name="name">The name of the parameter.</param>
|
<param name="parameterType">The EDM type of the parameter.</param>
|
</member>
|
<member name="T:System.Web.Http.OData.Builder.ODataConventionModelBuilder">
|
<summary>Used to automatically map CLR classes to an EDM model based on a set of <see cref="T:System.Web.Http.OData.Builder.Conventions.IConvention" />s.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.ODataConventionModelBuilder.#ctor">
|
<summary>Initializes a new <see cref="T:System.Web.Http.OData.Builder.ODataConventionModelBuilder" />.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.ODataConventionModelBuilder.#ctor(System.Web.Http.HttpConfiguration)">
|
<summary>Initializes a new <see cref="T:System.Web.Http.OData.Builder.ODataConventionModelBuilder" />.</summary>
|
<param name="configuration">The <see cref="T:System.Web.Http.HttpConfiguration" /> to use.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.ODataConventionModelBuilder.AddComplexType(System.Type)">
|
<returns>Returns <see cref="T:System.Web.Http.OData.Builder.ComplexTypeConfiguration" />.</returns>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.ODataConventionModelBuilder.AddEntity(System.Type)">
|
<returns>Returns <see cref="T:System.Web.Http.OData.Builder.EntityTypeConfiguration" />.</returns>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.ODataConventionModelBuilder.AddEntitySet(System.String,System.Web.Http.OData.Builder.EntityTypeConfiguration)">
|
<returns>Returns <see cref="T:System.Web.Http.OData.Builder.EntitySetConfiguration" />.</returns>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.ODataConventionModelBuilder.GetEdmModel">
|
<returns>Returns <see cref="T:Microsoft.Data.Edm.IEdmModel" />.</returns>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.ODataConventionModelBuilder.Ignore``1">
|
<summary>Excludes a type or types from the model. This is used to remove types from the model that were added by convention during initial model discovery.</summary>
|
<returns>The same <see cref="T:System.Web.Http.OData.Builder.ODataConventionModelBuilder" />so that multiple calls can be chained.</returns>
|
<typeparam name="T"></typeparam>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.ODataConventionModelBuilder.Ignore(System.Type[])">
|
<summary>Excludes a type or types from the model. This is used to remove types from the model that were added by convention during initial model discovery.</summary>
|
<returns>The same <see cref="T:System.Web.Http.OData.Builder.ODataConventionModelBuilder" />so that multiple calls can be chained.</returns>
|
<param name="types">The types to be excluded from the model.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.ODataConventionModelBuilder.OnModelCreating">
|
<summary>This action is invoked after the <see cref="T:System.Web.Http.OData.Builder.ODataConventionModelBuilder" /> has run all the conventions, but before the configuration is locked down and used to build the <see cref="T:Microsoft.Data.Edm.IEdmModel" /> .</summary>
|
</member>
|
<member name="T:System.Web.Http.OData.Builder.ODataModelBuilder">
|
<summary>Used to map CLR classes to an EDM model.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.ODataModelBuilder.#ctor">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Builder.ODataModelBuilder" /> class.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.ODataModelBuilder.Action(System.String)">
|
<summary>Adds a non-bindable action to the builder.</summary>
|
<returns>The configuration object for the specified action.</returns>
|
<param name="name">The name of the action.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.ODataModelBuilder.AddComplexType(System.Type)">
|
<summary>Registers a complex type as part of the model and returns an object that can be used to configure the entity. This method can be called multiple times for the same entity to perform multiple lines of configuration.</summary>
|
<returns>The configuration object for the specified complex type.</returns>
|
<param name="type">The type to be registered or configured.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.ODataModelBuilder.AddEntity(System.Type)">
|
<summary>Registers an entity type as part of the model and returns an object that can be used to configure the entity. This method can be called multiple times for the same entity to perform multiple lines of configuration.</summary>
|
<returns>The configuration object for the specified entity type.</returns>
|
<param name="type">The type to be registered or configured.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.ODataModelBuilder.AddEntitySet(System.String,System.Web.Http.OData.Builder.EntityTypeConfiguration)">
|
<summary>Registers an entity set as a part of the model and returns an object that can be used to configure the entity set. This method can be called multiple times for the same type to perform multiple lines of configuration.</summary>
|
<returns>The configuration object for the specified entity set.</returns>
|
<param name="name">The name of the entity set.</param>
|
<param name="entityType">The type to be registered or configured.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.ODataModelBuilder.AddProcedure(System.Web.Http.OData.Builder.ProcedureConfiguration)">
|
<summary>Adds a procedure to the model.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.ODataModelBuilder.ComplexType``1">
|
<summary>Registers a type as a complex type in the model and returns an object that can be used to configure the complex type. This method can be called multiple times for the same type to perform multiple lines of configuration.</summary>
|
<returns>The configuration object for the specified complex type.</returns>
|
<typeparam name="TComplexType">The type to be registered or configured.</typeparam>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.ODataModelBuilder.ContainerName">
|
<summary>Gets or sets the name of the container that will hold all the EntitySets, Actions and Functions</summary>
|
<returns>Returns <see cref="T:System.String" />.</returns>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.ODataModelBuilder.DataServiceVersion">
|
<summary>Gets or sets the data service version of the model. The default value is 3.0.</summary>
|
<returns>Returns <see cref="T:System.Version" />.</returns>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.ODataModelBuilder.Entity``1">
|
<summary>Registers an entity type as part of the model and returns an object that can be used to configure the entity. This method can be called multiple times for the same entity to perform multiple lines of configuration.</summary>
|
<returns>The configuration object for the specified entity type.</returns>
|
<typeparam name="TEntityType">The type to be registered or configured.</typeparam>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.ODataModelBuilder.EntitySet``1(System.String)">
|
<summary>Registers an entity set as a part of the model and returns an object that can be used to configure the entity set. This method can be called multiple times for the same type to perform multiple lines of configuration.</summary>
|
<returns>The configuration object for the specified entity set.</returns>
|
<param name="name">The name of the entity set.</param>
|
<typeparam name="TEntityType">The entity type of the entity set.</typeparam>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.ODataModelBuilder.EntitySets">
|
<summary>Gets the collection of EDM entity sets in the model to be built.</summary>
|
<returns>Returns <see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.ODataModelBuilder.GetEdmModel">
|
<summary>Creates a <see cref="T:Microsoft.Data.Edm.IEdmModel" /> based on the configuration performed using this builder.</summary>
|
<returns>The model that was built.</returns>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.ODataModelBuilder.GetTypeConfigurationOrNull(System.Type)">
|
<summary>Attempts to find either a pre-configured structural type or a primitive type that matches the T. If no matches are found NULL is returned.</summary>
|
<returns>Returns <see cref="T:System.Web.Http.OData.Builder.IEdmTypeConfiguration" />.</returns>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.ODataModelBuilder.MaxDataServiceVersion">
|
<summary>Gets or sets the maximum data service version of the model. The default value is 3.0.</summary>
|
<returns>Returns <see cref="T:System.Version" />.</returns>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.ODataModelBuilder.Namespace">
|
<summary>Gets or sets the namespace that will be used for the resulting model</summary>
|
<returns>Returns <see cref="T:System.String" />.</returns>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.ODataModelBuilder.Procedures">
|
<summary>Gets the collection of Procedures (i.e. Actions, Functions and ServiceOperations) in the model to be built</summary>
|
<returns>Returns <see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.ODataModelBuilder.RemoveEntitySet(System.String)">
|
<summary>Removes the entity set from the model.</summary>
|
<returns>true if the entity set is present in the model; false otherwise.</returns>
|
<param name="name">The name of the entity set to be removed</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.ODataModelBuilder.RemoveProcedure(System.String)">
|
<summary>Removes the procedure from the model.</summary>
|
<returns>true if the procedure is present in the model; false otherwise.</returns>
|
<param name="name">The name of the procedure to be removed.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.ODataModelBuilder.RemoveProcedure(System.Web.Http.OData.Builder.ProcedureConfiguration)">
|
<summary>Removes the procedure from the model.</summary>
|
<returns>true if the procedure is present in the model; false otherwise.</returns>
|
<param name="procedure">The procedure to be removed.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.ODataModelBuilder.RemoveStructuralType(System.Type)">
|
<summary>Removes the type from the model.</summary>
|
<returns>true if the type is present in the model and false otherwise.</returns>
|
<param name="type">The type to be removed</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.ODataModelBuilder.StructuralTypes">
|
<summary>Gets the collection of EDM types in the model to be built.</summary>
|
<returns>Returns <see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
|
</member>
|
<member name="T:System.Web.Http.OData.Builder.ParameterConfiguration">
|
<summary>Represents a parameter to a Procedure.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.ParameterConfiguration.#ctor(System.String,System.Web.Http.OData.Builder.IEdmTypeConfiguration)">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Builder.ParameterConfiguration" /> class.</summary>
|
<param name="name">The name of the parameter.</param>
|
<param name="parameterType">The EDM type of the parameter.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.ParameterConfiguration.Name">
|
<summary>The name of the parameter.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.ParameterConfiguration.TypeConfiguration">
|
<summary>The type of the parameter.</summary>
|
</member>
|
<member name="T:System.Web.Http.OData.Builder.PrimitivePropertyConfiguration">
|
<summary>Used to configure a primitive property of an entity type or complex type. This configuration functionality is exposed by the model builder Fluent API, see <see cref="T:System.Web.Http.OData.Builder.ODataModelBuilder" /> .</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.PrimitivePropertyConfiguration.#ctor(System.Reflection.PropertyInfo,System.Web.Http.OData.Builder.StructuralTypeConfiguration)">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Builder.PrimitivePropertyConfiguration" /> class.</summary>
|
<param name="property">The name of the property.</param>
|
<param name="declaringType">The declaring EDM type of the property.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.PrimitivePropertyConfiguration.IsOptional">
|
<summary>Configures the property to be optional.</summary>
|
<returns>Returns itself so that multiple calls can be chained.</returns>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.PrimitivePropertyConfiguration.IsRequired">
|
<summary>Configures the property to be required.</summary>
|
<returns>Returns itself so that multiple calls can be chained.</returns>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.PrimitivePropertyConfiguration.Kind">
|
<summary>Gets the type of this property.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.PrimitivePropertyConfiguration.RelatedClrType">
|
<summary>Gets the backing CLR type of this property type.</summary>
|
</member>
|
<member name="T:System.Web.Http.OData.Builder.PrimitiveTypeConfiguration">
|
<summary>Represents a PrimitiveType</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.PrimitiveTypeConfiguration.#ctor(System.Web.Http.OData.Builder.ODataModelBuilder,Microsoft.Data.Edm.IEdmPrimitiveType,System.Type)">
|
<summary>This constructor is public only for unit testing purposes. To get a PrimitiveTypeConfiguration use ODataModelBuilder.GetTypeConfigurationOrNull(Type).</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.PrimitiveTypeConfiguration.ClrType">
|
<summary>Gets the backing CLR type of this EDM type.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.PrimitiveTypeConfiguration.EdmPrimitiveType">
|
<summary>Returns the IEdmPrimitiveType associated with this PrimitiveTypeConfiguration</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.PrimitiveTypeConfiguration.FullName">
|
<summary>Gets the full name of this EDM type.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.PrimitiveTypeConfiguration.Kind">
|
<summary>Gets the <see cref="T:Microsoft.Data.Edm.EdmTypeKind" /> of this EDM type.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.PrimitiveTypeConfiguration.ModelBuilder">
|
<summary>Gets the associated <see cref="T:System.Web.Http.OData.Builder.ODataModelBuilder" /> .</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.PrimitiveTypeConfiguration.Name">
|
<summary>Gets the name of this EDM type.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.PrimitiveTypeConfiguration.Namespace">
|
<summary>Gets the namespace of this EDM type.</summary>
|
</member>
|
<member name="T:System.Web.Http.OData.Builder.ProcedureConfiguration">
|
<summary>Represents a Procedure that is exposed in the model.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.ProcedureConfiguration.#ctor"></member>
|
<member name="P:System.Web.Http.OData.Builder.ProcedureConfiguration.ContainerQualifiedName">
|
<summary>The qualified name of the procedure when used in OData urls. Qualification is required to distinguish the procedure from other possible single part identifiers.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.ProcedureConfiguration.EntitySet">
|
<summary>The EntitySet that entities are returned from.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.ProcedureConfiguration.FullName">
|
<summary>The FullName is the ContainerQualifiedName.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.ProcedureConfiguration.FullyQualifiedName">
|
<summary>The FullyQualifiedName is the ContainerQualifiedName further qualified using the Namespace. Typically this is not required, because most services have at most one container with the same name.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.ProcedureConfiguration.IsAlwaysBindable">
|
<summary>If the procedure IsBindable is it Always bindable.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.ProcedureConfiguration.IsBindable">
|
<summary>Can the procedure be bound to a url representing the BindingParameter.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.ProcedureConfiguration.IsComposable">
|
<summary>Can the procedure be composed upon. For example can a URL that invokes the procedure be used as the base url for a request that invokes the procedure and does something else with the results.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.ProcedureConfiguration.IsSideEffecting">
|
<summary>Does the procedure have side-effects.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.ProcedureConfiguration.Kind">
|
<summary>The Kind of procedure, which can be either Action, Function or ServiceOperation.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.ProcedureConfiguration.ModelBuilder">
|
<summary>Gets or sets the associated <see cref="T:System.Web.Http.OData.Builder.ODataModelBuilder" />.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.ProcedureConfiguration.Name">
|
<summary>The Name of the procedure.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.ProcedureConfiguration.Parameters">
|
<summary>The parameters the procedure takes.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.ProcedureConfiguration.ReturnType">
|
<summary>The type returned when the procedure is invoked.</summary>
|
</member>
|
<member name="T:System.Web.Http.OData.Builder.ProcedureKind">
|
<summary>The Kind of OData Procedure. One of Action, Function or ServiceOperation.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Builder.ProcedureKind.Action">
|
<summary>An action.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Builder.ProcedureKind.Function">
|
<summary>A function.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Builder.ProcedureKind.ServiceOperation">
|
<summary>A service operation.</summary>
|
</member>
|
<member name="T:System.Web.Http.OData.Builder.PropertyConfiguration">
|
<summary>Base class for all property configurations.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.PropertyConfiguration.#ctor(System.Reflection.PropertyInfo,System.Web.Http.OData.Builder.StructuralTypeConfiguration)">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Builder.PropertyConfiguration" /> class.</summary>
|
<param name="property">The name of the property.</param>
|
<param name="declaringType">The declaring EDM type of the property.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.PropertyConfiguration.AddedExplicitly">
|
<summary>Gets or sets a value that is true if the property was added by the user; false if it was inferred through conventions.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.PropertyConfiguration.DeclaringType">
|
<summary>Gets the declaring type.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.PropertyConfiguration.Kind">
|
<summary>Gets the <see cref="T:System.Web.Http.OData.Builder.PropertyKind" /> of the property.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.PropertyConfiguration.Name">
|
<summary>Gets the name of the property.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.PropertyConfiguration.PropertyInfo">
|
<summary>Gets the mapping CLR <see cref="P:System.Web.Http.OData.Builder.PropertyConfiguration.PropertyInfo" />.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.PropertyConfiguration.RelatedClrType">
|
<summary>Gets the CLR <see cref="T:System.Type" /> of the property.</summary>
|
</member>
|
<member name="T:System.Web.Http.OData.Builder.PropertyKind">
|
<summary>The kind of the EDM property.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Builder.PropertyKind.Primitive">
|
<summary>Represents an EDM primitive property.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Builder.PropertyKind.Complex">
|
<summary>Represents an EDM complex property.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Builder.PropertyKind.Collection">
|
<summary>Represents an EDM collection property.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Builder.PropertyKind.Navigation">
|
<summary>Represents an EDM navigation property.</summary>
|
</member>
|
<member name="T:System.Web.Http.OData.Builder.SelfLinkBuilder`1">
|
<summary> Encapsulates a self-link factory and whether the link factory follows conventions or not. </summary>
|
<typeparam name="T">The type of the self link generated. This should be for ID links and for read and edit links.</typeparam>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.SelfLinkBuilder`1.#ctor(System.Func{System.Web.Http.OData.EntityInstanceContext,`0},System.Boolean)">
|
<summary> Constructs a new instance of <see cref="T:System.Web.Http.OData.Builder.SelfLinkBuilder`1" />. </summary>
|
<param name="linkFactory">The link factory.</param>
|
<param name="followsConventions">Whether the factory follows odata conventions for link generation.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.SelfLinkBuilder`1.Factory">
|
<summary> Gets the factory for generating links. </summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.SelfLinkBuilder`1.FollowsConventions">
|
<summary> Gets a boolean indicating whether the link factory follows OData conventions or not. </summary>
|
</member>
|
<member name="T:System.Web.Http.OData.Builder.StructuralPropertyConfiguration">
|
<summary>Base class for all structural property configurations.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.StructuralPropertyConfiguration.#ctor(System.Reflection.PropertyInfo,System.Web.Http.OData.Builder.StructuralTypeConfiguration)">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Builder.StructuralPropertyConfiguration" /> class.</summary>
|
<param name="property">The property of the configuration.</param>
|
<param name="declaringType">The declaring type of the property.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.StructuralPropertyConfiguration.OptionalProperty">
|
<summary>Gets or sets a value indicating whether this property is optional or not.</summary>
|
</member>
|
<member name="T:System.Web.Http.OData.Builder.StructuralTypeConfiguration">
|
<summary>Represents an <see cref="T:Microsoft.Data.Edm.IEdmStructuredType" /> that can be built using <see cref="T:System.Web.Http.OData.Builder.ODataModelBuilder" />.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.StructuralTypeConfiguration.#ctor">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Builder.StructuralTypeConfiguration" /> class.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.StructuralTypeConfiguration.#ctor(System.Web.Http.OData.Builder.ODataModelBuilder,System.Type)">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Builder.StructuralTypeConfiguration" /> class.</summary>
|
<param name="modelBuilder">The associated <see cref="T:System.Web.Http.OData.Builder.ODataModelBuilder" />.</param>
|
<param name="clrType">The backing CLR type for this EDM structural type.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.StructuralTypeConfiguration.AddCollectionProperty(System.Reflection.PropertyInfo)">
|
<summary>Adds a collection property to this edm type.</summary>
|
<returns>The <see cref="T:System.Web.Http.OData.Builder.CollectionPropertyConfiguration" /> so that the property can be configured further.</returns>
|
<param name="propertyInfo">The property being added.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.StructuralTypeConfiguration.AddComplexProperty(System.Reflection.PropertyInfo)">
|
<summary>Adds a complex property to this edm type.</summary>
|
<returns>The <see cref="T:System.Web.Http.OData.Builder.ComplexPropertyConfiguration" /> so that the property can be configured further.</returns>
|
<param name="propertyInfo">The property being added.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.StructuralTypeConfiguration.AddProperty(System.Reflection.PropertyInfo)">
|
<summary>Adds a primitive property to this edm type.</summary>
|
<returns>The <see cref="T:System.Web.Http.OData.Builder.PrimitivePropertyConfiguration" /> so that the property can be configured further.</returns>
|
<param name="propertyInfo">The property being added.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.StructuralTypeConfiguration.ClrType">
|
<summary>Gets the backing CLR <see cref="T:System.Type" />.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.StructuralTypeConfiguration.ExplicitProperties">
|
<summary>Gets the collection of explicitly added properties.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.StructuralTypeConfiguration.FullName">
|
<summary>Gets the full name of this EDM type.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.StructuralTypeConfiguration.IgnoredProperties">
|
<summary>Gets the properties from the backing CLR type that are to be ignored on this EDM type.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.StructuralTypeConfiguration.Kind">
|
<summary>Gets the <see cref="T:Microsoft.Data.Edm.EdmTypeKind" /> of this EDM type.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.StructuralTypeConfiguration.ModelBuilder">
|
<summary>The <see cref="T:System.Web.Http.OData.Builder.ODataModelBuilder" />.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.StructuralTypeConfiguration.Name">
|
<summary>Gets the name of this EDM type.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.StructuralTypeConfiguration.Namespace">
|
<summary>Gets the namespace of this EDM type.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.StructuralTypeConfiguration.Properties">
|
<summary>Gets the declared properties on this EDM type.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.StructuralTypeConfiguration.RemovedProperties">
|
<summary>Gets the collection of explicitly removed properties.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.StructuralTypeConfiguration.RemoveProperty(System.Reflection.PropertyInfo)">
|
<summary>Removes the given property.</summary>
|
<param name="propertyInfo">The property being removed.</param>
|
</member>
|
<member name="T:System.Web.Http.OData.Builder.StructuralTypeConfiguration`1">
|
<summary>Represents an <see cref="T:Microsoft.Data.Edm.IEdmStructuredType" /> that can be built using <see cref="T:System.Web.Http.OData.Builder.ODataModelBuilder" /> .</summary>
|
<typeparam name="TStructuralType"></typeparam>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.StructuralTypeConfiguration`1.#ctor(System.Web.Http.OData.Builder.StructuralTypeConfiguration)">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Builder.StructuralTypeConfiguration`1" /> class.</summary>
|
<param name="configuration">The inner configuration of the structural type.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.StructuralTypeConfiguration`1.CollectionProperty``1(System.Linq.Expressions.Expression{System.Func{`0,System.Collections.Generic.IEnumerable{``0}}})">
|
<summary>Adds a collection property to the EDM type.</summary>
|
<returns>A configuration object that can be used to further configure the property.</returns>
|
<param name="propertyExpression">A lambda expression representing the navigation property for the relationship. For example, in C# t => t.MyProperty and in Visual Basic .NET Function(t) t.MyProperty .</param>
|
<typeparam name="TElementType">The element type of the collection.</typeparam>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.StructuralTypeConfiguration`1.ComplexProperty``1(System.Linq.Expressions.Expression{System.Func{`0,``0}})">
|
<summary>Adds a complex property to the EDM type.</summary>
|
<returns>A configuration object that can be used to further configure the property.</returns>
|
<param name="propertyExpression">A lambda expression representing the navigation property for the relationship. For example, in C# t => t.MyProperty and in Visual Basic .NET Function(t) t.MyProperty .</param>
|
<typeparam name="TComplexType">The complex type.</typeparam>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.StructuralTypeConfiguration`1.Ignore``1(System.Linq.Expressions.Expression{System.Func{`0,``0}})">
|
<summary>Excludes a property from the type.</summary>
|
<param name="propertyExpression">A lambda expression representing the navigation property for the relationship. For example, in C# t => t.MyProperty and in Visual Basic .NET Function(t) t.MyProperty .</param>
|
<typeparam name="TProperty">The property type.</typeparam>
|
</member>
|
<member name="P:System.Web.Http.OData.Builder.StructuralTypeConfiguration`1.Properties">
|
<summary>Gets the collection of EDM structural properties that belong to this type.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.StructuralTypeConfiguration`1.Property(System.Linq.Expressions.Expression{System.Func{`0,System.Byte[]}})">
|
<summary>Adds a binary property to the EDM type.</summary>
|
<returns>A configuration object that can be used to further configure the property.</returns>
|
<param name="propertyExpression">A lambda expression representing the navigation property for the relationship. For example, in C# t => t.MyProperty and in Visual Basic .NET Function(t) t.MyProperty .</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.StructuralTypeConfiguration`1.Property(System.Linq.Expressions.Expression{System.Func{`0,System.IO.Stream}})">
|
<summary>Adds a stream property to the EDM type.</summary>
|
<returns>A configuration object that can be used to further configure the property.</returns>
|
<param name="propertyExpression">A lambda expression representing the navigation property for the relationship. For example, in C# t => t.MyProperty and in Visual Basic .NET Function(t) t.MyProperty .</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.StructuralTypeConfiguration`1.Property``1(System.Linq.Expressions.Expression{System.Func{`0,System.Nullable{``0}}})">
|
<summary>Adds an optional primitive property to the EDM type.</summary>
|
<returns>A configuration object that can be used to further configure the property.</returns>
|
<param name="propertyExpression">A lambda expression representing the navigation property for the relationship. For example, in C# t => t.MyProperty and in Visual Basic .NET Function(t) t.MyProperty .</param>
|
<typeparam name="T">The primitive property type.</typeparam>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.StructuralTypeConfiguration`1.Property(System.Linq.Expressions.Expression{System.Func{`0,System.String}})">
|
<summary>Adds a string property to the EDM type.</summary>
|
<returns>A configuration object that can be used to further configure the property.</returns>
|
<param name="propertyExpression">A lambda expression representing the navigation property for the relationship. For example, in C# t => t.MyProperty and in Visual Basic .NET Function(t) t.MyProperty .</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Builder.StructuralTypeConfiguration`1.Property``1(System.Linq.Expressions.Expression{System.Func{`0,``0}})">
|
<summary>Adds a required primitive property to the EDM type.</summary>
|
<returns>A configuration object that can be used to further configure the property.</returns>
|
<param name="propertyExpression">A lambda expression representing the navigation property for the relationship. For example, in C# t => t.MyProperty and in Visual Basic .NET Function(t) t.MyProperty .</param>
|
<typeparam name="T">The primitive property type.</typeparam>
|
</member>
|
<member name="T:System.Web.Http.OData.Formatter.ODataMediaTypeFormatter">
|
<summary>
|
<see cref="T:System.Net.Http.Formatting.MediaTypeFormatter" /> class to handle OData.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Formatter.ODataMediaTypeFormatter.CanReadType(System.Type)">
|
<returns>Returns <see cref="T:System.Boolean" />.</returns>
|
</member>
|
<member name="M:System.Web.Http.OData.Formatter.ODataMediaTypeFormatter.CanWriteType(System.Type)">
|
<returns>Returns <see cref="T:System.Boolean" />.</returns>
|
</member>
|
<member name="M:System.Web.Http.OData.Formatter.ODataMediaTypeFormatter.GetPerRequestFormatterInstance(System.Type,System.Net.Http.HttpRequestMessage,System.Net.Http.Headers.MediaTypeHeaderValue)">
|
<returns>Returns <see cref="T:System.Net.Http.Formatting.MediaTypeFormatter" />.</returns>
|
</member>
|
<member name="P:System.Web.Http.OData.Formatter.ODataMediaTypeFormatter.MessageReaderQuotas">
|
<summary>Gets or sets the <see cref="T:Microsoft.Data.OData.ODataMessageQuotas" /> that this formatter uses on the read side.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Formatter.ODataMediaTypeFormatter.MessageWriterQuotas">
|
<summary>Gets or sets the <see cref="T:Microsoft.Data.OData.ODataMessageQuotas" /> that this formatter uses on the write side.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Formatter.ODataMediaTypeFormatter.ReadFromStreamAsync(System.Type,System.IO.Stream,System.Net.Http.HttpContent,System.Net.Http.Formatting.IFormatterLogger)">
|
<returns>Returns <see cref="T:System.Threading.Tasks.Task`1" />.</returns>
|
</member>
|
<member name="M:System.Web.Http.OData.Formatter.ODataMediaTypeFormatter.SetDefaultContentHeaders(System.Type,System.Net.Http.Headers.HttpContentHeaders,System.Net.Http.Headers.MediaTypeHeaderValue)"></member>
|
<member name="M:System.Web.Http.OData.Formatter.ODataMediaTypeFormatter.WriteToStreamAsync(System.Type,System.Object,System.IO.Stream,System.Net.Http.HttpContent,System.Net.TransportContext)">
|
<returns>Returns <see cref="T:System.Threading.Tasks.Task" />.</returns>
|
</member>
|
<member name="T:System.Web.Http.OData.Formatter.ODataMediaTypeFormatters">
|
<summary>
|
<see cref="T:System.Net.Http.Formatting.MediaTypeFormatter" /> classes to handle OData.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Formatter.ODataMediaTypeFormatters.Create">
|
<summary>Creates a list of media type formatters to handle OData.</summary>
|
<returns>A list of media type formatters to handle OData.</returns>
|
</member>
|
<member name="T:System.Web.Http.OData.Formatter.ODataModelBinderProvider">
|
<summary>Provides a <see cref="T:System.Web.Http.ModelBinding.IModelBinder" /> for EDM primitive types.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Formatter.ODataModelBinderProvider.#ctor"></member>
|
<member name="M:System.Web.Http.OData.Formatter.ODataModelBinderProvider.GetBinder(System.Web.Http.HttpConfiguration,System.Type)">
|
<returns>Returns <see cref="T:System.Web.Http.ModelBinding.IModelBinder" />.</returns>
|
</member>
|
<member name="T:System.Web.Http.OData.Query.AllowedArithmeticOperators">
|
<summary>Arithmetic operators to allow for querying using $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedArithmeticOperators.None">
|
<summary>A value that corresponds to allowing no arithmetic operators in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedArithmeticOperators.Add">
|
<summary>A value that corresponds to allowing 'Add' arithmetic operator in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedArithmeticOperators.Subtract">
|
<summary>A value that corresponds to allowing 'Subtract' arithmetic operator in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedArithmeticOperators.Multiply">
|
<summary>A value that corresponds to allowing 'Multiply' arithmetic operator in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedArithmeticOperators.Divide">
|
<summary>A value that corresponds to allowing 'Divide' arithmetic operator in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedArithmeticOperators.Modulo">
|
<summary>A value that corresponds to allowing 'Modulo' arithmetic operator in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedArithmeticOperators.All">
|
<summary>A value that corresponds to allowing all arithmetic operators in $filter.</summary>
|
</member>
|
<member name="T:System.Web.Http.OData.Query.AllowedFunctions">
|
<summary>Functions to allow for querying using $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedFunctions.None">
|
<summary>A value that corresponds to allowing no functions in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedFunctions.StartsWith">
|
<summary>A value that corresponds to allowing 'StartsWith' function in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedFunctions.EndsWith">
|
<summary>A value that corresponds to allowing 'EndsWith' function in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedFunctions.SubstringOf">
|
<summary>A value that corresponds to allowing 'SubstringOf' function in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedFunctions.Length">
|
<summary>A value that corresponds to allowing 'Length' function in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedFunctions.IndexOf">
|
<summary>A value that corresponds to allowing 'IndexOf' function in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedFunctions.Concat">
|
<summary>A value that corresponds to allowing 'Concat' function in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedFunctions.Substring">
|
<summary>A value that corresponds to allowing 'Substring' function in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedFunctions.ToLower">
|
<summary>A value that corresponds to allowing 'ToLower' function in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedFunctions.ToUpper">
|
<summary>A value that corresponds to allowing 'ToUpper' function in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedFunctions.Trim">
|
<summary>A value that corresponds to allowing 'Trim' function in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedFunctions.Cast">
|
<summary>A value that corresponds to allowing 'Cast' function in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedFunctions.Year">
|
<summary>A value that corresponds to allowing 'Year' function in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedFunctions.Years">
|
<summary>A value that corresponds to allowing 'Years' function in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedFunctions.Month">
|
<summary>A value that corresponds to allowing 'Month' function in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedFunctions.Months">
|
<summary>A value that corresponds to allowing 'Months' function in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedFunctions.Day">
|
<summary>A value that corresponds to allowing 'Day' function in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedFunctions.Days">
|
<summary>A value that corresponds to allowing 'Days' function in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedFunctions.Hour">
|
<summary>A value that corresponds to allowing 'Hour' function in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedFunctions.Hours">
|
<summary>A value that corresponds to allowing 'Hours' function in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedFunctions.Minute">
|
<summary>A value that corresponds to allowing 'Minute' function in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedFunctions.Minutes">
|
<summary>A value that corresponds to allowing 'Minutes' function in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedFunctions.Second">
|
<summary>A value that corresponds to allowing 'Second' function in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedFunctions.Seconds">
|
<summary>A value that corresponds to allowing 'Seconds' function in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedFunctions.Round">
|
<summary>A value that corresponds to allowing 'Round' function in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedFunctions.Floor">
|
<summary>A value that corresponds to allowing 'Floor' function in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedFunctions.Ceiling">
|
<summary>A value that corresponds to allowing 'Ceiling' function in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedFunctions.IsOf">
|
<summary>A value that corresponds to allowing 'IsOf' function in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedFunctions.Any">
|
<summary>A value that corresponds to allowing 'Any' function in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedFunctions.All">
|
<summary>A value that corresponds to allowing 'All' function in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedFunctions.AllStringFunctions">
|
<summary>A value that corresponds to allowing all string-related functions in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedFunctions.AllDateTimeFunctions">
|
<summary>A value that corresponds to allowing all datetime related functions in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedFunctions.AllMathFunctions">
|
<summary>A value that corresponds to allowing math-related functions in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedFunctions.AllFunctions">
|
<summary>A value that corresponds to allowing all functions in $filter.</summary>
|
</member>
|
<member name="T:System.Web.Http.OData.Query.AllowedLogicalOperators">
|
<summary>Logical operators to allow for querying using $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedLogicalOperators.None">
|
<summary>A value that corresponds to allowing no logical operators in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedLogicalOperators.Or">
|
<summary>A value that corresponds to allowing 'Or' logical operator in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedLogicalOperators.And">
|
<summary>A value that corresponds to allowing 'And' logical operator in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedLogicalOperators.Equal">
|
<summary>A value that corresponds to allowing 'Equal' logical operator in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedLogicalOperators.NotEqual">
|
<summary>A value that corresponds to allowing 'NotEqual' logical operator in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedLogicalOperators.GreaterThan">
|
<summary>A value that corresponds to allowing 'GreaterThan' logical operator in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedLogicalOperators.GreaterThanOrEqual">
|
<summary>A value that corresponds to allowing 'GreaterThanOrEqual' logical operator in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedLogicalOperators.LessThan">
|
<summary>A value that corresponds to allowing 'LessThan' logical operator in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedLogicalOperators.LessThanOrEqual">
|
<summary>A value that corresponds to allowing 'LessThanOrEqual' logical operator in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedLogicalOperators.Not">
|
<summary>A value that corresponds to allowing 'Not' logical operator in $filter.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedLogicalOperators.All">
|
<summary>A value that corresponds to allowing all logical operators in $filter.</summary>
|
</member>
|
<member name="T:System.Web.Http.OData.Query.AllowedQueryOptions">
|
<summary>OData query options to allow for querying.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedQueryOptions.None">
|
<summary>A value that corresponds to allowing no query options.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedQueryOptions.Filter">
|
<summary>A value that corresponds to allowing the $filter query option.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedQueryOptions.Expand">
|
<summary>A value that corresponds to allowing the $expand query option.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedQueryOptions.Select">
|
<summary>A value that corresponds to allowing the $select query option.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedQueryOptions.OrderBy">
|
<summary>A value that corresponds to allowing the $orderby query option.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedQueryOptions.Top">
|
<summary>A value that corresponds to allowing the $top query option.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedQueryOptions.Skip">
|
<summary>A value that corresponds to allowing the $skip query option.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedQueryOptions.InlineCount">
|
<summary>A value that corresponds to allowing the $inlinecount query option.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedQueryOptions.Format">
|
<summary>A value that corresponds to allowing the $format query option.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedQueryOptions.SkipToken">
|
<summary>A value that corresponds to allowing the $skiptoken query option.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedQueryOptions.Supported">
|
<summary>A value that corresponds to the default query options supported by <see cref="T:System.Web.Http.QueryableAttribute" />.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.AllowedQueryOptions.All">
|
<summary>A value that corresponds to allowing all query options.</summary>
|
</member>
|
<member name="T:System.Web.Http.OData.Query.FilterQueryOption">
|
<summary>This defines a $filter OData query option for querying.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.FilterQueryOption.#ctor(System.String,System.Web.Http.OData.ODataQueryContext)">
|
<summary>Initialize a new instance of <see cref="T:System.Web.Http.OData.Query.FilterQueryOption" /> based on the raw $filter value and an EdmModel from <see cref="T:System.Web.Http.OData.ODataQueryContext" /> .</summary>
|
<param name="rawValue">The raw value for $filter query. It can be null or empty.</param>
|
<param name="context">The <see cref="T:System.Web.Http.OData.ODataQueryContext" /> which contains the <see cref="T:Microsoft.Data.Edm.IEdmModel" /> and some type information</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.FilterQueryOption.ApplyTo(System.Linq.IQueryable,System.Web.Http.OData.Query.ODataQuerySettings)">
|
<summary>Applies the filter query to the given <see cref="T:System.Linq.IQueryable" />.</summary>
|
<returns>The new <see cref="T:System.Linq.IQueryable" /> after the filter query has been applied.</returns>
|
<param name="query">The original <see cref="T:System.Linq.IQueryable" />.</param>
|
<param name="querySettings">The <see cref="T:System.Web.Http.OData.Query.ODataQuerySettings" /> that contains all the query application-related settings.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.FilterQueryOption.ApplyTo(System.Linq.IQueryable,System.Web.Http.OData.Query.ODataQuerySettings,System.Web.Http.Dispatcher.IAssembliesResolver)">
|
<summary>Applies the filter query to the given IQueryable.</summary>
|
<returns>The new <see cref="T:System.Linq.IQueryable" /> after the filter query has been applied.</returns>
|
<param name="query">The original <see cref="T:System.Linq.IQueryable" />.</param>
|
<param name="querySettings">The <see cref="T:System.Web.Http.OData.Query.ODataQuerySettings" /> that contains all the query application-related settings.</param>
|
<param name="assembliesResolver">The <see cref="T:System.Web.Http.Dispatcher.IAssembliesResolver" /> to use.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.FilterQueryOption.Context">
|
<summary>Gets the given <see cref="T:System.Web.Http.OData.ODataQueryContext" /> .</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.FilterQueryOption.FilterClause">
|
<summary>Gets the parsed <see cref="P:System.Web.Http.OData.Query.FilterQueryOption.FilterClause" /> for this query option.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.FilterQueryOption.RawValue">
|
<summary>Gets the raw $filter value.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.FilterQueryOption.Validate(System.Web.Http.OData.Query.ODataValidationSettings)">
|
<summary>Validate the filter query based on the given <paramref name="validationSettings" /> . It throws an ODataException if validation failed.</summary>
|
<param name="validationSettings">The <see cref="T:System.Web.Http.OData.Query.ODataValidationSettings" /> instance which contains all the validation settings.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.FilterQueryOption.Validator">
|
<summary>Gets or sets the Filter Query Validator</summary>
|
</member>
|
<member name="T:System.Web.Http.OData.Query.HandleNullPropagationOption">
|
<summary>This enum defines how to handle null propagation in queriable support.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.HandleNullPropagationOption.Default">
|
<summary>Determine how to handle null propagation based on the query provider during query composition. This is the default value used in <see cref="T:System.Web.Http.OData.Query.ODataQuerySettings" /></summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.HandleNullPropagationOption.True">
|
<summary>Handle null propagation during query composition.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.HandleNullPropagationOption.False">
|
<summary>Do not handle null propagation during query composition.</summary>
|
</member>
|
<member name="T:System.Web.Http.OData.Query.InlineCountQueryOption">
|
<summary>Represents the value of the $inlinecount query option and exposes a way to retrieve the number of entities that satisfy a query.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.InlineCountQueryOption.#ctor(System.String,System.Web.Http.OData.ODataQueryContext)">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Query.InlineCountQueryOption" /> class.</summary>
|
<param name="rawValue">The raw value for the $inlinecount query option.</param>
|
<param name="context">The <see cref="T:System.Web.Http.OData.ODataQueryContext" /> which contains the <see cref="T:Microsoft.Data.Edm.IEdmModel" /> and some type information</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.InlineCountQueryOption.Context">
|
<summary>Gets the given <see cref="T:System.Web.Http.OData.ODataQueryContext" />.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.InlineCountQueryOption.GetEntityCount(System.Linq.IQueryable)">
|
<summary>Gets the number of entities that satisfies the given query if the response should include an inline count, or null otherwise.</summary>
|
<returns>The number of entities that satisfy the specified query if the response should include an inline count, or null otherwise.</returns>
|
<param name="query">The query to compute the count for.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.InlineCountQueryOption.RawValue">
|
<summary>Gets the raw $inlinecount value.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.InlineCountQueryOption.Value">
|
<summary>Gets the value of the $inlinecount in a parsed form.</summary>
|
</member>
|
<member name="T:System.Web.Http.OData.Query.InlineCountValue">
|
<summary>Defines an enumeration for $inlinecount query option values.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.InlineCountValue.None">
|
<summary>Corresponds to the 'none' $inlinecount query option value.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Query.InlineCountValue.AllPages">
|
<summary>Corresponds to the 'allpages' $inlinecount query option value.</summary>
|
</member>
|
<member name="T:System.Web.Http.OData.Query.ODataQueryOptions">
|
<summary>This defines a composite OData query option that can be used to perform query composition. Currently this only supports $filter, $orderby, $top, $skip, and $inlinecount.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.ODataQueryOptions.#ctor(System.Web.Http.OData.ODataQueryContext,System.Net.Http.HttpRequestMessage)">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Query.ODataQueryOptions" /> class based on the incoming request and some metadata information from the <see cref="T:System.Web.Http.OData.ODataQueryContext" /> .</summary>
|
<param name="context">The <see cref="T:System.Web.Http.OData.ODataQueryContext" /> which contains the <see cref="T:Microsoft.Data.Edm.IEdmModel" /> and some type information.</param>
|
<param name="request">The incoming request message.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.ODataQueryOptions.ApplyTo(System.Linq.IQueryable)">
|
<summary> Apply the individual query to the given IQueryable in the right order.</summary>
|
<returns>The query that the query has been applied to.</returns>
|
<param name="query">The IQueryable that we are applying query against.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.ODataQueryOptions.ApplyTo(System.Linq.IQueryable,System.Web.Http.OData.Query.ODataQuerySettings)">
|
<summary>Apply the individual query to the given IQueryable in the right order.</summary>
|
<returns>The query that the query has been applied to.</returns>
|
<param name="query">The IQueryable that we are applying query against.</param>
|
<param name="querySettings">The settings to use in query composition.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.ODataQueryOptions.Context">
|
<summary>Gets the given <see cref="T:System.Web.Http.OData.ODataQueryContext" /></summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.ODataQueryOptions.Filter">
|
<summary>Gets the <see cref="T:System.Web.Http.OData.Query.FilterQueryOption" /> .</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.ODataQueryOptions.InlineCount">
|
<summary>Gets the <see cref="T:System.Web.Http.OData.Query.InlineCountQueryOption" /> .</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.ODataQueryOptions.IsSystemQueryOption(System.String)">
|
<summary>Check if the given query option is an OData system query option.</summary>
|
<returns>Returns true if the query option is an OData system query option.</returns>
|
<param name="queryOptionName">The name of the query option.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.ODataQueryOptions.LimitResults``1(System.Linq.IQueryable{``0},System.Int32,System.Boolean@)">
|
<summary>Limits the query results to a maximum number of results.</summary>
|
<returns>The limited query results.</returns>
|
<param name="queryable">The queryable to limit.</param>
|
<param name="limit">The query result limit.</param>
|
<param name="resultsLimited">true if the query results were limited; false otherwise</param>
|
<typeparam name="T">The entity CLR type</typeparam>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.ODataQueryOptions.OrderBy">
|
<summary>Gets the <see cref="T:System.Web.Http.OData.Query.OrderByQueryOption" /> .</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.ODataQueryOptions.RawValues">
|
<summary>Gets the raw string of all the OData query options</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.ODataQueryOptions.Request">
|
<summary>Gets the request message associated with this instance.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.ODataQueryOptions.Skip">
|
<summary>Gets the <see cref="T:System.Web.Http.OData.Query.SkipQueryOption" /> .</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.ODataQueryOptions.Top">
|
<summary>Gets the <see cref="T:System.Web.Http.OData.Query.TopQueryOption" /> .</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.ODataQueryOptions.Validate(System.Web.Http.OData.Query.ODataValidationSettings)">
|
<summary>Validate all odata queries, including $skip, $top, $orderby and $filter, based on the given <paramref name="validationSettings" /> . It throws an ODataException if validation failed.</summary>
|
<param name="validationSettings">The <see cref="T:System.Web.Http.OData.Query.ODataValidationSettings" /> instance which contains all the validation settings.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.ODataQueryOptions.Validator">
|
<summary>Gets or sets the query validator.</summary>
|
</member>
|
<member name="T:System.Web.Http.OData.Query.ODataQueryOptions`1">
|
<summary>This defines a composite OData query option that can be used to perform query composition. Currently this only supports $filter, $orderby, $top, $skip.</summary>
|
<typeparam name="TEntity"></typeparam>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.ODataQueryOptions`1.#ctor(System.Web.Http.OData.ODataQueryContext,System.Net.Http.HttpRequestMessage)">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Query.ODataQueryOptions" /> class based on the incoming request and some metadata information from the <see cref="T:System.Web.Http.OData.ODataQueryContext" /> .</summary>
|
<param name="context">The <see cref="T:System.Web.Http.OData.ODataQueryContext" /> which contains the <see cref="T:Microsoft.Data.Edm.IEdmModel" /> and some type information</param>
|
<param name="request">The incoming request message</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.ODataQueryOptions`1.ApplyTo(System.Linq.IQueryable)">
|
<summary>Apply the individual query to the given IQueryable in the right order.</summary>
|
<returns>The query that the query has been applied to.</returns>
|
<param name="query">The IQueryable that we are applying query against.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.ODataQueryOptions`1.ApplyTo(System.Linq.IQueryable,System.Web.Http.OData.Query.ODataQuerySettings)">
|
<summary>Apply the individual query to the given IQueryable in the right order.</summary>
|
<returns>The query that the query has been applied to.</returns>
|
<param name="query">The IQueryable that we are applying query against.</param>
|
<param name="querySettings">The settings to use in query composition.</param>
|
</member>
|
<member name="T:System.Web.Http.OData.Query.ODataQuerySettings">
|
<summary>This class describes the settings to use during query composition.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.ODataQuerySettings.#ctor">
|
<summary>Instantiates a new instance of the <see cref="T:System.Web.Http.OData.Query.ODataQuerySettings" /> class and initializes the default settings.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.ODataQuerySettings.#ctor(System.Web.Http.OData.Query.ODataQuerySettings)">
|
<summary>Initialize a new instance of the <see cref="T:System.Web.Http.OData.Query.ODataQuerySettings" /> class based on an existing one.</summary>
|
<param name="settings">The setting to copy from.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.ODataQuerySettings.EnableConstantParameterization">
|
<summary>Gets or sets a value indicating whether constants should be parameterized. Parameterizing constants would result in better performance with Entity framework.</summary>
|
<returns>The default value is true .</returns>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.ODataQuerySettings.EnsureStableOrdering">
|
<summary>Gets or sets a value indicating whether query composition should alter the original query when necessary to ensure a stable sort order.</summary>
|
<returns>A true value indicates the original query should be modified when necessary to guarantee a stable sort order. A false value indicates the sort order can be considered stable without modifying the query. Query providers that ensure a stable sort order should set this value to false . The default value is true .</returns>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.ODataQuerySettings.HandleNullPropagation">
|
<summary>Gets or sets a value indicating how null propagation should be handled during query composition.</summary>
|
<returns>The default is <see cref="F:System.Web.Http.OData.Query.HandleNullPropagationOption.Default" /> .</returns>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.ODataQuerySettings.PageSize">
|
<summary>Gets or sets the maximum number of query results to return.</summary>
|
<returns>The maximum number of query results to return, or null if there is no limit.</returns>
|
</member>
|
<member name="T:System.Web.Http.OData.Query.ODataRawQueryOptions">
|
<summary>Represents the raw query values in the string format from the incoming request.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.ODataRawQueryOptions.#ctor"></member>
|
<member name="P:System.Web.Http.OData.Query.ODataRawQueryOptions.Expand">
|
<summary>Gets the raw $expand query value from the incoming request Uri if exists.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.ODataRawQueryOptions.Filter">
|
<summary>Gets the raw $filter query value from the incoming request Uri if exists.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.ODataRawQueryOptions.Format">
|
<summary>Gets the raw $format query value from the incoming request Uri if exists.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.ODataRawQueryOptions.InlineCount">
|
<summary>Gets the raw $inlineCount query value from the incoming request Uri if exists.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.ODataRawQueryOptions.OrderBy">
|
<summary>Gets the raw $orderby query value from the incoming request Uri if exists.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.ODataRawQueryOptions.Select">
|
<summary>Gets the raw $select query value from the incoming request Uri if exists.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.ODataRawQueryOptions.Skip">
|
<summary>Gets the raw $skip query value from the incoming request Uri if exists.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.ODataRawQueryOptions.SkipToken">
|
<summary>Gets the raw $skiptoken query value from the incoming request Uri if exists.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.ODataRawQueryOptions.Top">
|
<summary>Gets the raw $top query value from the incoming request Uri if exists.</summary>
|
</member>
|
<member name="T:System.Web.Http.OData.Query.ODataValidationSettings">
|
<summary>This class describes the validation settings for querying.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.ODataValidationSettings.#ctor">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Query.ODataValidationSettings" /> class.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.ODataValidationSettings.AllowedArithmeticOperators">
|
<summary>Gets or sets a list of allowed arithmetic operators including 'add', 'sub', 'mul', 'div', 'mod'.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.ODataValidationSettings.AllowedFunctions">
|
<summary>Gets or sets a list of allowed functions used in the $filter query. The allowed functions include the following: String related: substringof, endswith, startswith, length, indexof, substring, tolower, toupper, trim, concat e.g. ~/Customers?$filter=length(CompanyName) eq 19 DateTime related: year, years, month, months, day, days, hour, hours, minute, minutes, second, seconds e.g. ~/Employees?$filter=year(BirthDate) eq 1971 Math related: round, floor, ceiling Type related:isof, cast, Collection related: any, all</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.ODataValidationSettings.AllowedLogicalOperators">
|
<summary>Gets or sets a list of allowed logical operators such as 'eq', 'ne', 'gt', 'ge', 'lt', 'le', 'and', 'or', 'not'.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.ODataValidationSettings.AllowedOrderByProperties">
|
<summary>Gets a list of properties one can order by the result with. Note, by default this list is empty, it means it can be ordered by any property. For example, having an empty collection means the client can order the queriable result by any properties. Adding "Name" to this list means that it only allows queriable result to be ordered by the Name property.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.ODataValidationSettings.AllowedQueryOptions">
|
<summary>Gets or sets the query parameters that are allowed inside query. The default is all query options, including $filter, $skip, $top, $orderby, $expand, $select, $inlineCount, $format and $skiptoken.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.ODataValidationSettings.MaxAnyAllExpressionDepth">
|
<summary>Gets or sets the maximum depth of the Any or All elements nested inside the query.</summary>
|
<returns>The maximum depth of the Any or All elements nested inside the query.</returns>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.ODataValidationSettings.MaxNodeCount">
|
<summary>Gets or sets the maximum number of the nodes inside the $filter syntax tree.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.ODataValidationSettings.MaxSkip">
|
<summary>Gets or sets the max value of $skip that a client can request.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.ODataValidationSettings.MaxTop">
|
<summary>Gets or sets the max value of $top that a client can request.</summary>
|
</member>
|
<member name="T:System.Web.Http.OData.Query.OrderByItNode">
|
<summary>Represents the order by expression '$it' in the $orderby clause.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.OrderByItNode.#ctor(Microsoft.Data.OData.Query.OrderByDirection)">
|
<summary>Instantiates a new instance of <see cref="T:System.Web.Http.OData.Query.OrderByItNode" /> class.</summary>
|
<param name="direction">The <see cref="T:Microsoft.Data.OData.Query.OrderByDirection" /> for this node.</param>
|
</member>
|
<member name="T:System.Web.Http.OData.Query.OrderByNode">
|
<summary>Represents a single order by expression in the $orderby clause.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.OrderByNode.#ctor(Microsoft.Data.OData.Query.OrderByDirection)">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Query.OrderByNode" /> class.</summary>
|
<param name="direction">The direction of the sort order.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.OrderByNode.CreateCollection(Microsoft.Data.OData.Query.SemanticAst.OrderByClause)">
|
<summary>Creates a list of <see cref="T:System.Web.Http.OData.Query.OrderByPropertyNode" /> instances from a linked list of <see cref="T:Microsoft.Data.OData.Query.SemanticAst.OrderByClause" /> instances.</summary>
|
<returns>The list of new <see cref="T:System.Web.Http.OData.Query.OrderByPropertyNode" /> instances.</returns>
|
<param name="orderByClause">The head of the <see cref="T:Microsoft.Data.OData.Query.SemanticAst.OrderByClause" /> linked list.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.OrderByNode.Direction">
|
<summary>Gets the <see cref="T:Microsoft.Data.OData.Query.OrderByDirection" /> for the current node.</summary>
|
</member>
|
<member name="T:System.Web.Http.OData.Query.OrderByPropertyNode">
|
<summary>Represents an order by <see cref="T:Microsoft.Data.Edm.IEdmProperty" /> expression.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.OrderByPropertyNode.#ctor(Microsoft.Data.Edm.IEdmProperty,Microsoft.Data.OData.Query.OrderByDirection)">
|
<summary>Instantiates a new instance of the <see cref="T:System.Web.Http.OData.Query.OrderByPropertyNode" /> class.</summary>
|
<param name="property">The <see cref="T:Microsoft.Data.Edm.IEdmProperty" /> for this node.</param>
|
<param name="direction">The <see cref="T:Microsoft.Data.OData.Query.OrderByDirection" /> for this node.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.OrderByPropertyNode.Property">
|
<summary>Gets the <see cref="T:Microsoft.Data.Edm.IEdmProperty" /> for the current node.</summary>
|
</member>
|
<member name="T:System.Web.Http.OData.Query.OrderByQueryOption">
|
<summary>This defines a $orderby OData query option for querying.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.OrderByQueryOption.#ctor(System.String,System.Web.Http.OData.ODataQueryContext)">
|
<summary>Initialize a new instance of <see cref="T:System.Web.Http.OData.Query.OrderByQueryOption" /> based on the raw $orderby value and an EdmModel from <see cref="T:System.Web.Http.OData.ODataQueryContext" /> .</summary>
|
<param name="rawValue">The raw value for $orderby query. It can be null or empty.</param>
|
<param name="context">The <see cref="T:System.Web.Http.OData.ODataQueryContext" /> which contains the <see cref="T:Microsoft.Data.Edm.IEdmModel" /> and some type information</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.OrderByQueryOption.ApplyTo(System.Linq.IQueryable)">
|
<summary>Apply the $orderby query to the given IQueryable.</summary>
|
<returns>The query that the orderby query has been applied to.</returns>
|
<param name="query">The IQueryable that we are applying orderby query against.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.OrderByQueryOption.ApplyTo``1(System.Linq.IQueryable{``0})">
|
<summary> Apply the $orderby query to the given IQueryable.</summary>
|
<returns>The query that the orderby query has been applied to.</returns>
|
<param name="query">The IQueryable that we are applying orderby query against.</param>
|
<typeparam name="T"></typeparam>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.OrderByQueryOption.Context">
|
<summary>Gets the given <see cref="T:System.Web.Http.OData.ODataQueryContext" />.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.OrderByQueryOption.OrderByNodes">
|
<summary>Gets the mutable list of <see cref="T:System.Web.Http.OData.Query.OrderByPropertyNode" /> instances for this query option.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.OrderByQueryOption.RawValue">
|
<summary>Gets the raw $orderby value.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.OrderByQueryOption.Validate(System.Web.Http.OData.Query.ODataValidationSettings)">
|
<summary>Validate the orderby query based on the given <paramref name="validationSettings" /> . It throws an ODataException if validation failed.</summary>
|
<param name="validationSettings">The <see cref="T:System.Web.Http.OData.Query.ODataValidationSettings" /> instance which contains all the validation settings.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.OrderByQueryOption.Validator">
|
<summary>Gets or sets the OrderBy Query Validator.</summary>
|
</member>
|
<member name="T:System.Web.Http.OData.Query.QueryFilterProvider">
|
<summary>An implementation of <see cref="T:System.Web.Http.Filters.IFilterProvider" /> that applies an action filter to any action with an <see cref="T:System.Linq.IQueryable" /> or <see cref="T:System.Linq.IQueryable`1" /> return type that doesn't bind a parameter of type <see cref="T:System.Web.Http.OData.Query.ODataQueryOptions" /> .</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.QueryFilterProvider.#ctor(System.Web.Http.Filters.IActionFilter)">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Query.QueryFilterProvider" /> class.</summary>
|
<param name="queryFilter">The action filter that executes the query.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.QueryFilterProvider.GetFilters(System.Web.Http.HttpConfiguration,System.Web.Http.Controllers.HttpActionDescriptor)">
|
<summary>Provides filters to apply to the specified action.</summary>
|
<returns>The filters to apply to the specified action.</returns>
|
<param name="configuration">The server configuration.</param>
|
<param name="actionDescriptor">The action descriptor for the action to provide filters for.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.QueryFilterProvider.QueryFilter">
|
<summary>Gets the action filter that executes the query.</summary>
|
</member>
|
<member name="T:System.Web.Http.OData.Query.SkipQueryOption">
|
<summary>This defines a $skip OData query option for querying.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.SkipQueryOption.#ctor(System.String,System.Web.Http.OData.ODataQueryContext)">
|
<summary>Initialize a new instance of <see cref="T:System.Web.Http.OData.Query.SkipQueryOption" /> based on the raw $skip value and an EdmModel from <see cref="T:System.Web.Http.OData.ODataQueryContext" /> .</summary>
|
<param name="rawValue">The raw value for $skip query. It can be null or empty.</param>
|
<param name="context">The <see cref="T:System.Web.Http.OData.ODataQueryContext" /> which contains the <see cref="T:Microsoft.Data.Edm.IEdmModel" /> and some type information</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.SkipQueryOption.ApplyTo(System.Linq.IQueryable,System.Web.Http.OData.Query.ODataQuerySettings)">
|
<summary>Applies the $skip query to the given IQueryable.</summary>
|
<returns>The new <see cref="T:System.Linq.IQueryable" /> after the skip query has been applied.</returns>
|
<param name="query">The original <see cref="T:System.Linq.IQueryable" />.</param>
|
<param name="querySettings">The query settings to use while applying this query option.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.SkipQueryOption.ApplyTo``1(System.Linq.IQueryable{``0},System.Web.Http.OData.Query.ODataQuerySettings)">
|
<summary>Applies the $skip query to the given IQueryable.</summary>
|
<returns>The new <see cref="T:System.Linq.IQueryable" /> after the skip query has been applied.</returns>
|
<param name="query">The original <see cref="T:System.Linq.IQueryable" />.</param>
|
<param name="querySettings">The query settings to use while applying this query option.</param>
|
<typeparam name="T"></typeparam>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.SkipQueryOption.Context">
|
<summary>Gets the given <see cref="T:System.Web.Http.OData.ODataQueryContext" /> .</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.SkipQueryOption.RawValue">
|
<summary>Gets the raw $skip value.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.SkipQueryOption.Validate(System.Web.Http.OData.Query.ODataValidationSettings)">
|
<summary>Validate the skip query based on the given <paramref name="validationSettings" /> . It throws an ODataException if validation failed.</summary>
|
<param name="validationSettings">The <see cref="T:System.Web.Http.OData.Query.ODataValidationSettings" /> instance which contains all the validation settings.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.SkipQueryOption.Validator">
|
<summary>Gets or sets the Skip Query Validator.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.SkipQueryOption.Value">
|
<summary>Gets the value of the $skip as a parsed integer.</summary>
|
</member>
|
<member name="T:System.Web.Http.OData.Query.TopQueryOption">
|
<summary>This defines a $top OData query option for querying.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.TopQueryOption.#ctor(System.String,System.Web.Http.OData.ODataQueryContext)">
|
<summary>Initialize a new instance of <see cref="T:System.Web.Http.OData.Query.TopQueryOption" /> based on the raw $top value and an EdmModel from <see cref="T:System.Web.Http.OData.ODataQueryContext" /> .</summary>
|
<param name="rawValue">The raw value for $top query. It can be null or empty.</param>
|
<param name="context">The <see cref="T:System.Web.Http.OData.ODataQueryContext" /> which contains the <see cref="T:Microsoft.Data.Edm.IEdmModel" /> and some type information</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.TopQueryOption.ApplyTo(System.Linq.IQueryable,System.Web.Http.OData.Query.ODataQuerySettings)">
|
<summary>Apply the $top query to the given IQueryable.</summary>
|
<returns>The new <see cref="T:System.Linq.IQueryable" /> after the top query has been applied.</returns>
|
<param name="query">The original <see cref="T:System.Linq.IQueryable" />.</param>
|
<param name="querySettings">The query settings to use while applying this query option.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.TopQueryOption.ApplyTo``1(System.Linq.IQueryable{``0},System.Web.Http.OData.Query.ODataQuerySettings)">
|
<summary>Apply the $top query to the given IQueryable.</summary>
|
<returns>The new <see cref="T:System.Linq.IQueryable" /> after the top query has been applied.</returns>
|
<param name="query">The original <see cref="T:System.Linq.IQueryable" />.</param>
|
<param name="querySettings">The query settings to use while applying this query option.</param>
|
<typeparam name="T"></typeparam>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.TopQueryOption.Context">
|
<summary>Gets the given <see cref="T:System.Web.Http.OData.ODataQueryContext" /> .</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.TopQueryOption.RawValue">
|
<summary>Gets the raw $top value.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.TopQueryOption.Validate(System.Web.Http.OData.Query.ODataValidationSettings)">
|
<summary>Validate the top query based on the given <paramref name="validationSettings" /> . It throws an ODataException if validation failed.</summary>
|
<param name="validationSettings">The <see cref="T:System.Web.Http.OData.Query.ODataValidationSettings" /> instance which contains all the validation settings.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.TopQueryOption.Validator">
|
<summary>Gets or sets the Top Query Validator.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Query.TopQueryOption.Value">
|
<summary>Gets the value of the $top as a parsed integer.</summary>
|
</member>
|
<member name="T:System.Web.Http.OData.Query.Validators.FilterQueryValidator">
|
<summary>Represents a validator used to validate a <see cref="T:System.Web.Http.OData.Query.FilterQueryOption" /> based on the <see cref="T:System.Web.Http.OData.Query.ODataValidationSettings" />.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.Validators.FilterQueryValidator.#ctor">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Query.Validators.FilterQueryValidator" /> class.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.Validators.FilterQueryValidator.Validate(System.Web.Http.OData.Query.FilterQueryOption,System.Web.Http.OData.Query.ODataValidationSettings)">
|
<summary>Validates a <see cref="T:System.Web.Http.OData.Query.FilterQueryOption" />.</summary>
|
<param name="filterQueryOption">The $filter query.</param>
|
<param name="settings">The validation settings.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.Validators.FilterQueryValidator.ValidateAllNode(Microsoft.Data.OData.Query.SemanticAst.AllNode,System.Web.Http.OData.Query.ODataValidationSettings)">
|
<summary>Override this method to restrict the 'all' query inside the filter query.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.Validators.FilterQueryValidator.ValidateAnyNode(Microsoft.Data.OData.Query.SemanticAst.AnyNode,System.Web.Http.OData.Query.ODataValidationSettings)">
|
<summary>Override this method to restrict the 'any' query inside the filter query.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.Validators.FilterQueryValidator.ValidateArithmeticOperator(Microsoft.Data.OData.Query.SemanticAst.BinaryOperatorNode,System.Web.Http.OData.Query.ODataValidationSettings)">
|
<summary>Override this method for the Arithmetic operators, including add, sub, mul, div, mod.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.Validators.FilterQueryValidator.ValidateBinaryOperatorNode(Microsoft.Data.OData.Query.SemanticAst.BinaryOperatorNode,System.Web.Http.OData.Query.ODataValidationSettings)">
|
<summary>Override this method to restrict the binary operators inside the filter query. That includes all the logical operators except 'not' and all math operators.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.Validators.FilterQueryValidator.ValidateCollectionPropertyAccessNode(Microsoft.Data.OData.Query.SemanticAst.CollectionPropertyAccessNode,System.Web.Http.OData.Query.ODataValidationSettings)">
|
<summary>Override this method to validate collection property accessor.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.Validators.FilterQueryValidator.ValidateConstantNode(Microsoft.Data.OData.Query.SemanticAst.ConstantNode,System.Web.Http.OData.Query.ODataValidationSettings)">
|
<summary>Override this method to restrict the 'constant' inside the filter query.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.Validators.FilterQueryValidator.ValidateConvertNode(Microsoft.Data.OData.Query.SemanticAst.ConvertNode,System.Web.Http.OData.Query.ODataValidationSettings)">
|
<summary>Override this method to restrict the 'cast' inside the filter query.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.Validators.FilterQueryValidator.ValidateEntityCollectionCastNode(Microsoft.Data.OData.Query.SemanticAst.EntityCollectionCastNode,System.Web.Http.OData.Query.ODataValidationSettings)">
|
<summary>Override this method if you want to validate casts on entity collections.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.Validators.FilterQueryValidator.ValidateLogicalOperator(Microsoft.Data.OData.Query.SemanticAst.BinaryOperatorNode,System.Web.Http.OData.Query.ODataValidationSettings)">
|
<summary>Override this method to validate the LogicalOperators such as 'eq', 'ne', 'gt', 'ge', 'lt', 'le', 'and', 'or'. Please note that 'not' is not included here. Please override ValidateUnaryOperatorNode to customize 'not'.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.Validators.FilterQueryValidator.ValidateNavigationPropertyNode(Microsoft.Data.OData.Query.SemanticAst.QueryNode,Microsoft.Data.Edm.IEdmNavigationProperty,System.Web.Http.OData.Query.ODataValidationSettings)">
|
<summary>Override this method for the navigation property node.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.Validators.FilterQueryValidator.ValidateQueryNode(Microsoft.Data.OData.Query.SemanticAst.QueryNode,System.Web.Http.OData.Query.ODataValidationSettings)">
|
<summary>Override this method if you want to visit each query node.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.Validators.FilterQueryValidator.ValidateRangeVariable(Microsoft.Data.OData.Query.SemanticAst.RangeVariable,System.Web.Http.OData.Query.ODataValidationSettings)">
|
<summary>Override this method to validate the parameter used in the filter query.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.Validators.FilterQueryValidator.ValidateSingleEntityCastNode(Microsoft.Data.OData.Query.SemanticAst.SingleEntityCastNode,System.Web.Http.OData.Query.ODataValidationSettings)">
|
<summary>Override this method if you want to validate casts on single entities.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.Validators.FilterQueryValidator.ValidateSingleValueFunctionCallNode(Microsoft.Data.OData.Query.SingleValueFunctionCallNode,System.Web.Http.OData.Query.ODataValidationSettings)">
|
<summary>Override this method to validate Function calls, such as 'length', 'years', etc.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.Validators.FilterQueryValidator.ValidateSingleValuePropertyAccessNode(Microsoft.Data.OData.Query.SemanticAst.SingleValuePropertyAccessNode,System.Web.Http.OData.Query.ODataValidationSettings)">
|
<summary>Override this method to validate property accessor.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.Validators.FilterQueryValidator.ValidateUnaryOperatorNode(Microsoft.Data.OData.Query.SemanticAst.UnaryOperatorNode,System.Web.Http.OData.Query.ODataValidationSettings)">
|
<summary>Override this method to validate the Not operator.</summary>
|
</member>
|
<member name="T:System.Web.Http.OData.Query.Validators.ODataQueryValidator">
|
<summary>Represents a validator used to validate OData queries based on the <see cref="T:System.Web.Http.OData.Query.ODataValidationSettings" />.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.Validators.ODataQueryValidator.#ctor">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Query.Validators.ODataQueryValidator" /> class.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.Validators.ODataQueryValidator.Validate(System.Web.Http.OData.Query.ODataQueryOptions,System.Web.Http.OData.Query.ODataValidationSettings)">
|
<summary>Validates the OData query.</summary>
|
<param name="options">The OData query to validate.</param>
|
<param name="validationSettings">The validation settings.</param>
|
</member>
|
<member name="T:System.Web.Http.OData.Query.Validators.OrderByQueryValidator">
|
<summary>Represents a validator used to validate an <see cref="T:System.Web.Http.OData.Query.OrderByQueryOption" /> based on the <see cref="T:System.Web.Http.OData.Query.ODataValidationSettings" />.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.Validators.OrderByQueryValidator.#ctor">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Query.Validators.OrderByQueryValidator" /> class.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.Validators.OrderByQueryValidator.Validate(System.Web.Http.OData.Query.OrderByQueryOption,System.Web.Http.OData.Query.ODataValidationSettings)">
|
<summary>Validates an <see cref="T:System.Web.Http.OData.Query.OrderByQueryOption" />.</summary>
|
<param name="orderByOption">The $orderby query.</param>
|
<param name="validationSettings">The validation settings.</param>
|
</member>
|
<member name="T:System.Web.Http.OData.Query.Validators.SkipQueryValidator">
|
<summary>Represents a validator used to validate a <see cref="T:System.Web.Http.OData.Query.SkipQueryOption" /> based on the <see cref="T:System.Web.Http.OData.Query.ODataValidationSettings" />.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.Validators.SkipQueryValidator.#ctor">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Query.Validators.SkipQueryValidator" /> class.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.Validators.SkipQueryValidator.Validate(System.Web.Http.OData.Query.SkipQueryOption,System.Web.Http.OData.Query.ODataValidationSettings)">
|
<summary>Validates a <see cref="T:System.Web.Http.OData.Query.SkipQueryOption" />.</summary>
|
<param name="skipQueryOption">The $skip query.</param>
|
<param name="validationSettings">The validation settings.</param>
|
</member>
|
<member name="T:System.Web.Http.OData.Query.Validators.TopQueryValidator">
|
<summary>Represents a validator used to validate a <see cref="T:System.Web.Http.OData.Query.TopQueryOption" /> based on the <see cref="T:System.Web.Http.OData.Query.ODataValidationSettings" />.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.Validators.TopQueryValidator.#ctor">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Query.Validators.TopQueryValidator" /> class.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Query.Validators.TopQueryValidator.Validate(System.Web.Http.OData.Query.TopQueryOption,System.Web.Http.OData.Query.ODataValidationSettings)">
|
<summary>Validates a <see cref="T:System.Web.Http.OData.Query.TopQueryOption" />.</summary>
|
<param name="topQueryOption">The $top query.</param>
|
<param name="validationSettings">The validation settings.</param>
|
</member>
|
<member name="T:System.Web.Http.OData.Routing.ActionPathSegment">
|
<summary>An <see cref="T:System.Web.Http.OData.Routing.ODataPathSegment" /> implementation representing an action invocation.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.ActionPathSegment.#ctor(Microsoft.Data.Edm.IEdmFunctionImport)">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Routing.ActionPathSegment" /> class.</summary>
|
<param name="action">The action being invoked.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.ActionPathSegment.#ctor(System.String)">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Routing.ActionPathSegment" /> class.</summary>
|
<param name="actionName">Name of the action.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Routing.ActionPathSegment.Action">
|
<summary>Gets the action being invoked.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Routing.ActionPathSegment.ActionName">
|
<summary>Gets the name of the action.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.ActionPathSegment.GetEdmType(Microsoft.Data.Edm.IEdmType)">
|
<summary>Gets the EDM type for this segment.</summary>
|
<returns>The EDM type for this segment.</returns>
|
<param name="previousEdmType">The EDM type of the previous path segment.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.ActionPathSegment.GetEntitySet(Microsoft.Data.Edm.IEdmEntitySet)">
|
<summary>Gets the entity set for this segment.</summary>
|
<returns>The entity set for this segment.</returns>
|
<param name="previousEntitySet">The entity set of the previous path segment.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Routing.ActionPathSegment.SegmentKind">
|
<summary>Gets the segment kind for the current segment.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.ActionPathSegment.ToString">
|
<summary>Returns a <see cref="T:System.String" /> that represents this instance.</summary>
|
<returns>A <see cref="T:System.String" /> that represents this instance.</returns>
|
</member>
|
<member name="T:System.Web.Http.OData.Routing.BatchPathSegment">
|
<summary>An <see cref="T:System.Web.Http.OData.Routing.ODataPathSegment" /> implementation representing a $batch segment.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.BatchPathSegment.#ctor"></member>
|
<member name="M:System.Web.Http.OData.Routing.BatchPathSegment.GetEdmType(Microsoft.Data.Edm.IEdmType)">
|
<summary>Gets the EDM type for this segment.</summary>
|
<returns>The EDM type for this segment.</returns>
|
<param name="previousEdmType">The EDM type of the previous path segment.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.BatchPathSegment.GetEntitySet(Microsoft.Data.Edm.IEdmEntitySet)">
|
<summary>Gets the entity set for this segment.</summary>
|
<returns>The entity set for this segment.</returns>
|
<param name="previousEntitySet">The entity set of the previous path segment.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Routing.BatchPathSegment.SegmentKind">
|
<summary>Gets the segment kind for the current segment.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.BatchPathSegment.ToString">
|
<summary>Returns a <see cref="T:System.String" /> that represents this instance.</summary>
|
<returns>A <see cref="T:System.String" /> that represents this instance.</returns>
|
</member>
|
<member name="T:System.Web.Http.OData.Routing.CastPathSegment">
|
<summary>An <see cref="T:System.Web.Http.OData.Routing.ODataPathSegment" /> implementation representing a cast.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.CastPathSegment.#ctor(Microsoft.Data.Edm.IEdmEntityType)">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Routing.CastPathSegment" /> class.</summary>
|
<param name="castType">The type of the cast.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.CastPathSegment.#ctor(System.String)">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Routing.CastPathSegment" /> class.</summary>
|
<param name="castTypeName">Name of the cast type.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Routing.CastPathSegment.CastType">
|
<summary>Gets the type of the cast.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Routing.CastPathSegment.CastTypeName">
|
<summary>Gets the name of the cast type.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.CastPathSegment.GetEdmType(Microsoft.Data.Edm.IEdmType)">
|
<summary>Gets the EDM type for this segment.</summary>
|
<returns>The EDM type for this segment.</returns>
|
<param name="previousEdmType">The EDM type of the previous path segment.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.CastPathSegment.GetEntitySet(Microsoft.Data.Edm.IEdmEntitySet)">
|
<summary>Gets the entity set for this segment.</summary>
|
<returns>The entity set for this segment.</returns>
|
<param name="previousEntitySet">The entity set of the previous path segment.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Routing.CastPathSegment.SegmentKind">
|
<summary>Gets the segment kind for the current segment.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.CastPathSegment.ToString">
|
<summary>Returns a <see cref="T:System.String" /> that represents this instance.</summary>
|
<returns>A <see cref="T:System.String" /> that represents this instance.</returns>
|
</member>
|
<member name="T:System.Web.Http.OData.Routing.DefaultODataPathHandler">
|
<summary>Parses an OData path as an <see cref="T:System.Web.Http.OData.Routing.ODataPath" /> and converts an <see cref="T:System.Web.Http.OData.Routing.ODataPath" /> into an OData link.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.DefaultODataPathHandler.#ctor">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Routing.DefaultODataPathHandler" /> class.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.DefaultODataPathHandler.Link(System.Web.Http.OData.Routing.ODataPath)">
|
<summary>Converts an instance of <see cref="T:System.Web.Http.OData.Routing.ODataPath" /> into an OData link.</summary>
|
<returns>The generated OData link.</returns>
|
<param name="path">The OData path to convert into a link.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.DefaultODataPathHandler.Parse(Microsoft.Data.Edm.IEdmModel,System.String)">
|
<summary>Parses the specified OData path as an <see cref="T:System.Web.Http.OData.Routing.ODataPath" /> that contains additional information about the EDM type and entity set for the path.</summary>
|
<returns>A parsed representation of the path, or null if the path does not match the model.</returns>
|
<param name="model">The model to use for path parsing.</param>
|
<param name="odataPath">The OData path to parse.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.DefaultODataPathHandler.ParseAtCollection(Microsoft.Data.Edm.IEdmModel,System.Web.Http.OData.Routing.ODataPathSegment,Microsoft.Data.Edm.IEdmType,System.String)">
|
<summary>Parses the next OData path segment following a collection.</summary>
|
<returns>A parsed representation of the segment.</returns>
|
<param name="model">The model to use for path parsing.</param>
|
<param name="previous">The previous path segment.</param>
|
<param name="previousEdmType">The EDM type of the OData path up to the previous segment.</param>
|
<param name="segment">The value of the segment to parse.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.DefaultODataPathHandler.ParseAtComplex(Microsoft.Data.Edm.IEdmModel,System.Web.Http.OData.Routing.ODataPathSegment,Microsoft.Data.Edm.IEdmType,System.String)">
|
<summary>Parses the next OData path segment following a complex-typed segment.</summary>
|
<returns>A parsed representation of the segment.</returns>
|
<param name="model">The model to use for path parsing.</param>
|
<param name="previous">The previous path segment.</param>
|
<param name="previousEdmType">The EDM type of the OData path up to the previous segment.</param>
|
<param name="segment">The value of the segment to parse.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.DefaultODataPathHandler.ParseAtEntity(Microsoft.Data.Edm.IEdmModel,System.Web.Http.OData.Routing.ODataPathSegment,Microsoft.Data.Edm.IEdmType,System.String)">
|
<summary>Parses the next OData path segment following an entity.</summary>
|
<returns>A parsed representation of the segment.</returns>
|
<param name="model">The model to use for path parsing.</param>
|
<param name="previous">The previous path segment.</param>
|
<param name="previousEdmType">The EDM type of the OData path up to the previous segment.</param>
|
<param name="segment">The value of the segment to parse.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.DefaultODataPathHandler.ParseAtEntityCollection(Microsoft.Data.Edm.IEdmModel,System.Web.Http.OData.Routing.ODataPathSegment,Microsoft.Data.Edm.IEdmType,System.String)">
|
<summary>Parses the next OData path segment following an entity collection.</summary>
|
<returns>A parsed representation of the segment.</returns>
|
<param name="model">The model to use for path parsing.</param>
|
<param name="previous">The previous path segment.</param>
|
<param name="previousEdmType">The EDM type of the OData path up to the previous segment.</param>
|
<param name="segment">The value of the segment to parse.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.DefaultODataPathHandler.ParseAtPrimitiveProperty(Microsoft.Data.Edm.IEdmModel,System.Web.Http.OData.Routing.ODataPathSegment,Microsoft.Data.Edm.IEdmType,System.String)">
|
<summary>Parses the next OData path segment following a primitive property.</summary>
|
<returns>A parsed representation of the segment.</returns>
|
<param name="model">The model to use for path parsing.</param>
|
<param name="previous">The previous path segment.</param>
|
<param name="previousEdmType">The EDM type of the OData path up to the previous segment.</param>
|
<param name="segment">The value of the segment to parse.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.DefaultODataPathHandler.ParseEntrySegment(Microsoft.Data.Edm.IEdmModel,System.String)">
|
<summary>Parses the first OData segment following the service base URI.</summary>
|
<returns>A parsed representation of the segment.</returns>
|
<param name="model">The model to use for path parsing.</param>
|
<param name="segment">The value of the segment to parse.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.DefaultODataPathHandler.ParseNextSegment(Microsoft.Data.Edm.IEdmModel,System.Web.Http.OData.Routing.ODataPathSegment,Microsoft.Data.Edm.IEdmType,System.String)">
|
<summary>Parses the next OData path segment.</summary>
|
<returns>A parsed representation of the segment.</returns>
|
<param name="model">The model to use for path parsing.</param>
|
<param name="previous">The previous path segment.</param>
|
<param name="previousEdmType">The EDM type of the OData path up to the previous segment.</param>
|
<param name="segment">The value of the segment to parse.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.DefaultODataPathHandler.ParseSegments(System.String)">
|
<summary>Parses the OData path into segments.</summary>
|
<returns>The segments of the OData path.</returns>
|
<param name="odataPath">The OData path.</param>
|
</member>
|
<member name="T:System.Web.Http.OData.Routing.EntitySetPathSegment">
|
<summary>An <see cref="T:System.Web.Http.OData.Routing.ODataPathSegment" /> implementation representing an entity set.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.EntitySetPathSegment.#ctor(Microsoft.Data.Edm.IEdmEntitySet)">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Routing.EntitySetPathSegment" /> class.</summary>
|
<param name="entitySet">The entity set being accessed.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.EntitySetPathSegment.#ctor(System.String)">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Routing.EntitySetPathSegment" /> class.</summary>
|
<param name="entitySetName">Name of the entity set.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Routing.EntitySetPathSegment.EntitySet">
|
<summary>Gets the entity set represented by this segment.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Routing.EntitySetPathSegment.EntitySetName">
|
<summary>Gets the name of the entity set.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.EntitySetPathSegment.GetEdmType(Microsoft.Data.Edm.IEdmType)">
|
<summary>Gets the EDM type for this segment.</summary>
|
<returns>The EDM type for this segment.</returns>
|
<param name="previousEdmType">The EDM type of the previous path segment.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.EntitySetPathSegment.GetEntitySet(Microsoft.Data.Edm.IEdmEntitySet)">
|
<summary>Gets the entity set for this segment.</summary>
|
<returns>The entity set for this segment.</returns>
|
<param name="previousEntitySet">The entity set of the previous path segment.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Routing.EntitySetPathSegment.SegmentKind">
|
<summary>Gets the segment kind for the current segment.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.EntitySetPathSegment.ToString">
|
<summary>Returns a <see cref="T:System.String" /> that represents this instance.</summary>
|
<returns>A <see cref="T:System.String" /> that represents this instance.</returns>
|
</member>
|
<member name="T:System.Web.Http.OData.Routing.IODataPathHandler">
|
<summary>Exposes the ability to parse an OData path as an <see cref="T:System.Web.Http.OData.Routing.ODataPath" /> and convert an <see cref="T:System.Web.Http.OData.Routing.ODataPath" /> into an OData link.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.IODataPathHandler.Link(System.Web.Http.OData.Routing.ODataPath)">
|
<summary>Converts an instance of <see cref="T:System.Web.Http.OData.Routing.ODataPath" /> into an OData link.</summary>
|
<returns>The generated OData link.</returns>
|
<param name="path">The OData path to convert into a link.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.IODataPathHandler.Parse(Microsoft.Data.Edm.IEdmModel,System.String)">
|
<summary>Parses the specified OData path as an <see cref="T:System.Web.Http.OData.Routing.ODataPath" /> that contains additional information about the EDM type and entity set for the path.</summary>
|
<returns>A parsed representation of the URI, or null if the URI does not match the model.</returns>
|
<param name="model">The model to use for path parsing.</param>
|
<param name="odataPath">The OData path to parse.</param>
|
</member>
|
<member name="T:System.Web.Http.OData.Routing.KeyValuePathSegment">
|
<summary>An <see cref="T:System.Web.Http.OData.Routing.ODataPathSegment" /> implementation representing an indexing into an entity collection by key.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.KeyValuePathSegment.#ctor(System.String)">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Routing.KeyValuePathSegment" /> class.</summary>
|
<param name="value">The key value to use for indexing into the collection.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.KeyValuePathSegment.GetEdmType(Microsoft.Data.Edm.IEdmType)">
|
<summary>Gets the EDM type for this segment.</summary>
|
<returns>The EDM type for this segment.</returns>
|
<param name="previousEdmType">The EDM type of the previous path segment.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.KeyValuePathSegment.GetEntitySet(Microsoft.Data.Edm.IEdmEntitySet)">
|
<summary>Gets the entity set for this segment.</summary>
|
<returns>The entity set for this segment.</returns>
|
<param name="previousEntitySet">The entity set of the previous path segment.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Routing.KeyValuePathSegment.SegmentKind">
|
<summary>Gets the segment kind for the current segment.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.KeyValuePathSegment.ToString">
|
<summary>Returns a <see cref="T:System.String" /> that represents this instance.</summary>
|
<returns>A <see cref="T:System.String" /> that represents this instance.</returns>
|
</member>
|
<member name="P:System.Web.Http.OData.Routing.KeyValuePathSegment.Value">
|
<summary>Gets the key value to use for indexing into the collection.</summary>
|
</member>
|
<member name="T:System.Web.Http.OData.Routing.LinksPathSegment">
|
<summary>An <see cref="T:System.Web.Http.OData.Routing.ODataPathSegment" /> implementation representing a $links segment.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.LinksPathSegment.#ctor"></member>
|
<member name="M:System.Web.Http.OData.Routing.LinksPathSegment.GetEdmType(Microsoft.Data.Edm.IEdmType)">
|
<summary>Gets the EDM type for this segment.</summary>
|
<returns>The EDM type for this segment.</returns>
|
<param name="previousEdmType">The EDM type of the previous path segment.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.LinksPathSegment.GetEntitySet(Microsoft.Data.Edm.IEdmEntitySet)">
|
<summary>Gets the entity set for this segment.</summary>
|
<returns>The entity set for this segment.</returns>
|
<param name="previousEntitySet">The entity set of the previous path segment.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Routing.LinksPathSegment.SegmentKind">
|
<summary>Gets the segment kind for the current segment.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.LinksPathSegment.ToString">
|
<summary>Returns a <see cref="T:System.String" /> that represents this instance.</summary>
|
<returns>A <see cref="T:System.String" /> that represents this instance.</returns>
|
</member>
|
<member name="T:System.Web.Http.OData.Routing.MetadataPathSegment">
|
<summary>An <see cref="T:System.Web.Http.OData.Routing.ODataPathSegment" /> implementation representing a $metadata segment.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.MetadataPathSegment.#ctor"></member>
|
<member name="M:System.Web.Http.OData.Routing.MetadataPathSegment.GetEdmType(Microsoft.Data.Edm.IEdmType)">
|
<summary>Gets the EDM type for this segment.</summary>
|
<returns>The EDM type for this segment.</returns>
|
<param name="previousEdmType">The EDM type of the previous path segment.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.MetadataPathSegment.GetEntitySet(Microsoft.Data.Edm.IEdmEntitySet)">
|
<summary>Gets the entity set for this segment.</summary>
|
<returns>The entity set for this segment.</returns>
|
<param name="previousEntitySet">The entity set of the previous path segment.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Routing.MetadataPathSegment.SegmentKind">
|
<summary>Gets the segment kind for the current segment.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.MetadataPathSegment.ToString">
|
<summary>Returns a <see cref="T:System.String" /> that represents this instance.</summary>
|
<returns>A <see cref="T:System.String" /> that represents this instance.</returns>
|
</member>
|
<member name="T:System.Web.Http.OData.Routing.NavigationPathSegment">
|
<summary>An <see cref="T:System.Web.Http.OData.Routing.ODataPathSegment" /> implementation representing a navigation.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.NavigationPathSegment.#ctor(Microsoft.Data.Edm.IEdmNavigationProperty)"></member>
|
<member name="M:System.Web.Http.OData.Routing.NavigationPathSegment.#ctor(System.String)"></member>
|
<member name="M:System.Web.Http.OData.Routing.NavigationPathSegment.GetEdmType(Microsoft.Data.Edm.IEdmType)">
|
<summary>Gets the EDM type for this segment.</summary>
|
<returns>The EDM type for this segment.</returns>
|
<param name="previousEdmType">The EDM type of the previous path segment.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.NavigationPathSegment.GetEntitySet(Microsoft.Data.Edm.IEdmEntitySet)">
|
<summary>Gets the entity set for this segment.</summary>
|
<returns>The entity set for this segment.</returns>
|
<param name="previousEntitySet">The entity set of the previous path segment.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Routing.NavigationPathSegment.NavigationProperty">
|
<summary>Gets the navigation property being accessed by this segment.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Routing.NavigationPathSegment.NavigationPropertyName">
|
<summary>Gets the name of the navigation property.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Routing.NavigationPathSegment.SegmentKind">
|
<summary>Gets the segment kind for the current segment.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.NavigationPathSegment.ToString">
|
<summary>Returns a <see cref="T:System.String" /> that represents this instance.</summary>
|
<returns>A <see cref="T:System.String" /> that represents this instance.</returns>
|
</member>
|
<member name="T:System.Web.Http.OData.Routing.ODataActionSelector">
|
<summary>An implementation of <see cref="T:System.Web.Http.Controllers.IHttpActionSelector" /> that uses the server's OData routing conventions to select an action for OData requests.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.ODataActionSelector.#ctor(System.Web.Http.Controllers.IHttpActionSelector)">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Routing.ODataActionSelector" /> class.</summary>
|
<param name="innerSelector">The inner controller selector to call.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.ODataActionSelector.GetActionMapping(System.Web.Http.Controllers.HttpControllerDescriptor)">
|
<summary>Returns a map, keyed by action string, of all <see cref="T:System.Web.Http.Controllers.HttpActionDescriptor" /> that the selector can select. This is primarily called by <see cref="T:System.Web.Http.Description.IApiExplorer" /> to discover all the possible actions in the controller.</summary>
|
<returns>A map of <see cref="T:System.Web.Http.Controllers.HttpActionDescriptor" /> that the selector can select, or null if the selector does not have a well-defined mapping of <see cref="T:System.Web.Http.Controllers.HttpActionDescriptor" /> .</returns>
|
<param name="controllerDescriptor">The controller descriptor.</param>
|
<exception cref="T:System.NotImplementedException"></exception>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.ODataActionSelector.SelectAction(System.Web.Http.Controllers.HttpControllerContext)">
|
<summary>Selects an action for the <see cref="T:System.Web.Http.Controllers.ApiControllerActionSelector" /> .</summary>
|
<returns>The selected action.</returns>
|
<param name="controllerContext">The controller context.</param>
|
</member>
|
<member name="T:System.Web.Http.OData.Routing.ODataPath">
|
<summary>Provides an object representation for an OData path with additional information about the EDM type and entity set for the path.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.ODataPath.#ctor(System.Collections.Generic.IList{System.Web.Http.OData.Routing.ODataPathSegment})">
|
<summary> Initializes a new instance of the <see cref="T:System.Web.Http.OData.Routing.ODataPath" /> class.</summary>
|
<param name="segments">The path segments for the path.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.ODataPath.#ctor(System.Web.Http.OData.Routing.ODataPathSegment[])">
|
<summary> Initializes a new instance of the <see cref="T:System.Web.Http.OData.Routing.ODataPath" /> class.</summary>
|
<param name="segments">The path segments for the path.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Routing.ODataPath.EdmType">
|
<summary>Gets or sets the EDM type of the path.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Routing.ODataPath.EntitySet">
|
<summary>Gets or sets the entity set of the path.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Routing.ODataPath.PathTemplate">
|
<summary>Gets the path template describing the types of segments in the path.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Routing.ODataPath.Segments">
|
<summary>Gets the path segments for the OData path.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.ODataPath.ToString">
|
<returns>Returns <see cref="T:System.String" />.</returns>
|
</member>
|
<member name="T:System.Web.Http.OData.Routing.ODataPathParameterBindingAttribute">
|
<summary>Implementation of <see cref="T:System.Web.Http.ParameterBindingAttribute" /> used to bind an instance of <see cref="T:System.Web.Http.OData.Routing.ODataPath" /> as an action parameter.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.ODataPathParameterBindingAttribute.#ctor">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Routing.ODataPathParameterBindingAttribute" /> class.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.ODataPathParameterBindingAttribute.GetBinding(System.Web.Http.Controllers.HttpParameterDescriptor)">
|
<summary>Gets the parameter binding.</summary>
|
<returns>The parameter binding.</returns>
|
<param name="parameter">The parameter description.</param>
|
</member>
|
<member name="T:System.Web.Http.OData.Routing.ODataPathRouteConstraint">
|
<summary>An implementation of <see cref="T:System.Web.Http.Routing.IHttpRouteConstraint" /> that only matches OData paths.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.ODataPathRouteConstraint.#ctor(System.Web.Http.OData.Routing.IODataPathHandler,Microsoft.Data.Edm.IEdmModel,System.String,System.Collections.Generic.IEnumerable{System.Web.Http.OData.Routing.Conventions.IODataRoutingConvention})">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Routing.ODataPathRouteConstraint" /> class.</summary>
|
<param name="pathHandler">The OData path handler to use for parsing.</param>
|
<param name="model">The EDM model to use for parsing the path.</param>
|
<param name="routeName">The name of the route this constraint is associated with.</param>
|
<param name="routingConventions">The OData routing conventions to use for selecting the controller name.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Routing.ODataPathRouteConstraint.EdmModel">
|
<summary>Gets the EDM model to use for parsing the path.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.ODataPathRouteConstraint.Match(System.Net.Http.HttpRequestMessage,System.Web.Http.Routing.IHttpRoute,System.String,System.Collections.Generic.IDictionary{System.String,System.Object},System.Web.Http.Routing.HttpRouteDirection)">
|
<summary>Determines whether this instance equals a specified route.</summary>
|
<returns>True if this instance equals a specified route; otherwise, false.</returns>
|
<param name="request">The request.</param>
|
<param name="route">The route to compare.</param>
|
<param name="parameterName">The name of the parameter.</param>
|
<param name="values">A list of parameter values.</param>
|
<param name="routeDirection">The route direction.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Routing.ODataPathRouteConstraint.PathHandler">
|
<summary>Gets the OData path handler to use for parsing.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Routing.ODataPathRouteConstraint.RouteName">
|
<summary>Gets the name of the route this constraint is associated with.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Routing.ODataPathRouteConstraint.RoutingConventions">
|
<summary>Gets the OData routing conventions to use for selecting the controller name.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.ODataPathRouteConstraint.SelectControllerName(System.Web.Http.OData.Routing.ODataPath,System.Net.Http.HttpRequestMessage)">
|
<summary>Selects the name of the controller to dispatch the request to.</summary>
|
<returns>The name of the controller to dispatch to, or null if one cannot be resolved.</returns>
|
<param name="path">The OData path of the request.</param>
|
<param name="request">The request.</param>
|
</member>
|
<member name="T:System.Web.Http.OData.Routing.ODataPathSegment">
|
<summary>Provides an object representation for an OData path segment with additional information about the EDM type and entity set for the path.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.ODataPathSegment.#ctor">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Routing.ODataPathSegment" /> class.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.ODataPathSegment.GetEdmType(Microsoft.Data.Edm.IEdmType)">
|
<summary>Gets the EDM type for this segment.</summary>
|
<returns>The EDM type for this segment.</returns>
|
<param name="previousEdmType">The EDM type of the previous path segment.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.ODataPathSegment.GetEntitySet(Microsoft.Data.Edm.IEdmEntitySet)">
|
<summary>Gets the entity set for this segment.</summary>
|
<returns>The entity set for this segment.</returns>
|
<param name="previousEntitySet">The entity set of the previous path segment.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Routing.ODataPathSegment.SegmentKind">
|
<summary>Gets the segment kind for the current segment.</summary>
|
</member>
|
<member name="T:System.Web.Http.OData.Routing.ODataRouteConstants">
|
<summary>This class contains route constants for OData.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Routing.ODataRouteConstants.Action">
|
<summary>Route data key for the action name.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Routing.ODataRouteConstants.ConstraintName">
|
<summary>Parameter name to use for the OData path route constraint.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Routing.ODataRouteConstants.Controller">
|
<summary>Route data key for the controller name.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Routing.ODataRouteConstants.Key">
|
<summary>Route data key for entity keys.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Routing.ODataRouteConstants.NavigationProperty">
|
<summary>Route data key for the navigation property name when manipulating links.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Routing.ODataRouteConstants.ODataPath">
|
<summary>Route variable name for the OData path.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Routing.ODataRouteConstants.ODataPathTemplate">
|
<summary>Wildcard route template for the OData path route variable.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Routing.ODataRouteConstants.RelatedKey">
|
<summary>Route data key for the related key when deleting links.</summary>
|
</member>
|
<member name="T:System.Web.Http.OData.Routing.ODataSegmentKinds">
|
<summary>Provides the values of segment kinds for implementations of <see cref="T:System.Web.Http.OData.Routing.ODataPathSegment" />.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Routing.ODataSegmentKinds.Action">
|
<summary>Represents a segment indicating an OData action.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Routing.ODataSegmentKinds.Batch">
|
<summary>Represents the OData $batch segment.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Routing.ODataSegmentKinds.Cast">
|
<summary>Represents a segment indicating a type cast.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Routing.ODataSegmentKinds.EntitySet">
|
<summary>Represents a segment indicating an entity set.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Routing.ODataSegmentKinds.Key">
|
<summary>Represents a segment indicating an index by key operation.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Routing.ODataSegmentKinds.Links">
|
<summary>Represents the OData $links segment.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Routing.ODataSegmentKinds.Metadata">
|
<summary>Represents the OData $metadata segment.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Routing.ODataSegmentKinds.Navigation">
|
<summary>Represents a segment indicating a navigation.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Routing.ODataSegmentKinds.Property">
|
<summary>Represents a segment indicating a property access.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Routing.ODataSegmentKinds.ServiceBase">
|
<summary>Represents the service root segment (for OData service document).</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Routing.ODataSegmentKinds.Unresolved">
|
<summary>Represents a segment that is not understood.</summary>
|
</member>
|
<member name="F:System.Web.Http.OData.Routing.ODataSegmentKinds.Value">
|
<summary>Represents the OData $value segment.</summary>
|
</member>
|
<member name="T:System.Web.Http.OData.Routing.PropertyAccessPathSegment">
|
<summary>An <see cref="T:System.Web.Http.OData.Routing.ODataPathSegment" /> implementation representing a property access.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.PropertyAccessPathSegment.#ctor(Microsoft.Data.Edm.IEdmProperty)">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Routing.PropertyAccessPathSegment" /> class.</summary>
|
<param name="property">The property being accessed by this segment.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.PropertyAccessPathSegment.#ctor(System.String)">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Routing.PropertyAccessPathSegment" /> class.</summary>
|
<param name="propertyName">Name of the property.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.PropertyAccessPathSegment.GetEdmType(Microsoft.Data.Edm.IEdmType)">
|
<summary>Gets the EDM type for this segment.</summary>
|
<returns>The EDM type for this segment.</returns>
|
<param name="previousEdmType">The EDM type of the previous path segment.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.PropertyAccessPathSegment.GetEntitySet(Microsoft.Data.Edm.IEdmEntitySet)">
|
<summary>Gets the entity set for this segment.</summary>
|
<returns>The entity set for this segment.</returns>
|
<param name="previousEntitySet">The entity set of the previous path segment.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Routing.PropertyAccessPathSegment.Property">
|
<summary>Gets the property property being accessed by this segment.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Routing.PropertyAccessPathSegment.PropertyName">
|
<summary>Gets the name of the property.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Routing.PropertyAccessPathSegment.SegmentKind">
|
<summary>Gets the segment kind for the current segment.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.PropertyAccessPathSegment.ToString">
|
<summary>Returns a <see cref="T:System.String" /> that represents this instance.</summary>
|
<returns>A <see cref="T:System.String" /> that represents this instance.</returns>
|
</member>
|
<member name="T:System.Web.Http.OData.Routing.UnresolvedPathSegment">
|
<summary>An <see cref="T:System.Web.Http.OData.Routing.ODataPathSegment" /> implementation representing a segment that could not be resolved.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.UnresolvedPathSegment.#ctor(System.String)">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Routing.UnresolvedPathSegment" /> class.</summary>
|
<param name="segmentValue">The unresolved segment value.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.UnresolvedPathSegment.GetEdmType(Microsoft.Data.Edm.IEdmType)">
|
<summary>Gets the EDM type for this segment.</summary>
|
<returns>The EDM type for this segment.</returns>
|
<param name="previousEdmType">The EDM type of the previous path segment.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.UnresolvedPathSegment.GetEntitySet(Microsoft.Data.Edm.IEdmEntitySet)">
|
<summary>Gets the entity set for this segment.</summary>
|
<returns>The entity set for this segment.</returns>
|
<param name="previousEntitySet">The entity set of the previous path segment.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Routing.UnresolvedPathSegment.SegmentKind">
|
<summary>Gets the segment kind for the current segment.</summary>
|
</member>
|
<member name="P:System.Web.Http.OData.Routing.UnresolvedPathSegment.SegmentValue">
|
<summary>Gets the unresolved segment value.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.UnresolvedPathSegment.ToString">
|
<summary>Returns a <see cref="T:System.String" /> that represents this instance.</summary>
|
<returns>A <see cref="T:System.String" /> that represents this instance.</returns>
|
</member>
|
<member name="T:System.Web.Http.OData.Routing.ValuePathSegment">
|
<summary>An <see cref="T:System.Web.Http.OData.Routing.ODataPathSegment" /> implementation representing a $value segment.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.ValuePathSegment.#ctor"></member>
|
<member name="M:System.Web.Http.OData.Routing.ValuePathSegment.GetEdmType(Microsoft.Data.Edm.IEdmType)">
|
<summary>Gets the EDM type for this segment.</summary>
|
<returns>The EDM type for this segment.</returns>
|
<param name="previousEdmType">The EDM type of the previous path segment.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.ValuePathSegment.GetEntitySet(Microsoft.Data.Edm.IEdmEntitySet)">
|
<summary>Gets the entity set for this segment.</summary>
|
<returns>The entity set for this segment.</returns>
|
<param name="previousEntitySet">The entity set of the previous path segment.</param>
|
</member>
|
<member name="P:System.Web.Http.OData.Routing.ValuePathSegment.SegmentKind">
|
<summary>Gets the segment kind for the current segment.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.ValuePathSegment.ToString">
|
<summary>Returns a <see cref="T:System.String" /> that represents this instance.</summary>
|
<returns>A <see cref="T:System.String" /> that represents this instance.</returns>
|
</member>
|
<member name="T:System.Web.Http.OData.Routing.Conventions.ActionRoutingConvention">
|
<summary>An implementation of <see cref="T:System.Web.Http.OData.Routing.Conventions.IODataRoutingConvention" /> that handles action invocations.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.Conventions.ActionRoutingConvention.#ctor">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Routing.Conventions.ActionRoutingConvention" /> class.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.Conventions.ActionRoutingConvention.SelectAction(System.Web.Http.OData.Routing.ODataPath,System.Web.Http.Controllers.HttpControllerContext,System.Linq.ILookup{System.String,System.Web.Http.Controllers.HttpActionDescriptor})">
|
<summary>Selects the action for OData requests.</summary>
|
<returns>null if the request isn't handled by this convention; otherwise, the name of the selected action</returns>
|
<param name="odataPath">The OData path.</param>
|
<param name="controllerContext">The controller context.</param>
|
<param name="actionMap">The action map.</param>
|
</member>
|
<member name="T:System.Web.Http.OData.Routing.Conventions.EntityRoutingConvention">
|
<summary>An implementation of <see cref="T:System.Web.Http.OData.Routing.Conventions.IODataRoutingConvention" /> that handles operating on entities by key.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.Conventions.EntityRoutingConvention.#ctor">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Routing.Conventions.EntityRoutingConvention" /> class.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.Conventions.EntityRoutingConvention.SelectAction(System.Web.Http.OData.Routing.ODataPath,System.Web.Http.Controllers.HttpControllerContext,System.Linq.ILookup{System.String,System.Web.Http.Controllers.HttpActionDescriptor})">
|
<summary>Selects the action for OData requests.</summary>
|
<returns>null if the request isn't handled by this convention; otherwise, the name of the selected action</returns>
|
<param name="odataPath">The OData path.</param>
|
<param name="controllerContext">The controller context.</param>
|
<param name="actionMap">The action map.</param>
|
</member>
|
<member name="T:System.Web.Http.OData.Routing.Conventions.EntitySetRoutingConvention">
|
<summary>An implementation of <see cref="T:System.Web.Http.OData.Routing.Conventions.IODataRoutingConvention" /> that handles entity sets.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.Conventions.EntitySetRoutingConvention.#ctor">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Routing.Conventions.EntitySetRoutingConvention" /> class.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.Conventions.EntitySetRoutingConvention.SelectAction(System.Web.Http.OData.Routing.ODataPath,System.Web.Http.Controllers.HttpControllerContext,System.Linq.ILookup{System.String,System.Web.Http.Controllers.HttpActionDescriptor})">
|
<summary>Selects the action for OData requests.</summary>
|
<returns>null if the request isn't handled by this convention; otherwise, the name of the selected action</returns>
|
<param name="odataPath">The OData path.</param>
|
<param name="controllerContext">The controller context.</param>
|
<param name="actionMap">The action map.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.Conventions.EntitySetRoutingConvention.SelectController(System.Web.Http.OData.Routing.ODataPath,System.Net.Http.HttpRequestMessage)">
|
<summary>Selects the controller for OData requests.</summary>
|
<returns>null if the request isn't handled by this convention; otherwise, the name of the selected controller</returns>
|
<param name="odataPath">The OData path.</param>
|
<param name="request">The request.</param>
|
</member>
|
<member name="T:System.Web.Http.OData.Routing.Conventions.IODataRoutingConvention">
|
<summary>Provides an abstraction for selecting a controller and an action for OData requests.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.Conventions.IODataRoutingConvention.SelectAction(System.Web.Http.OData.Routing.ODataPath,System.Web.Http.Controllers.HttpControllerContext,System.Linq.ILookup{System.String,System.Web.Http.Controllers.HttpActionDescriptor})">
|
<summary>Selects the action for OData requests.</summary>
|
<returns>null if the request isn't handled by this convention; otherwise, the name of the selected action</returns>
|
<param name="odataPath">The OData path.</param>
|
<param name="controllerContext">The controller context.</param>
|
<param name="actionMap">The action map.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.Conventions.IODataRoutingConvention.SelectController(System.Web.Http.OData.Routing.ODataPath,System.Net.Http.HttpRequestMessage)">
|
<summary>Selects the controller for OData requests.</summary>
|
<returns>null if the request isn't handled by this convention; otherwise, the name of the selected controller</returns>
|
<param name="odataPath">The OData path.</param>
|
<param name="request">The request.</param>
|
</member>
|
<member name="T:System.Web.Http.OData.Routing.Conventions.LinksRoutingConvention">
|
<summary>An implementation of <see cref="T:System.Web.Http.OData.Routing.Conventions.IODataRoutingConvention" /> that handles link manipulations.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.Conventions.LinksRoutingConvention.#ctor">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Routing.Conventions.LinksRoutingConvention" /> class.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.Conventions.LinksRoutingConvention.SelectAction(System.Web.Http.OData.Routing.ODataPath,System.Web.Http.Controllers.HttpControllerContext,System.Linq.ILookup{System.String,System.Web.Http.Controllers.HttpActionDescriptor})">
|
<summary>Selects the action.</summary>
|
<param name="odataPath">The odata path.</param>
|
<param name="controllerContext">The controller context.</param>
|
<param name="actionMap">The action map.</param>
|
</member>
|
<member name="T:System.Web.Http.OData.Routing.Conventions.MetadataRoutingConvention">
|
<summary>An implementation of <see cref="T:System.Web.Http.OData.Routing.Conventions.IODataRoutingConvention" /> that handles OData metadata requests.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.Conventions.MetadataRoutingConvention.#ctor">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Routing.Conventions.MetadataRoutingConvention" /> class.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.Conventions.MetadataRoutingConvention.SelectAction(System.Web.Http.OData.Routing.ODataPath,System.Web.Http.Controllers.HttpControllerContext,System.Linq.ILookup{System.String,System.Web.Http.Controllers.HttpActionDescriptor})">
|
<summary>Selects the action for OData requests.</summary>
|
<returns>null if the request isn't handled by this convention; otherwise, the name of the selected action</returns>
|
<param name="odataPath">The OData path.</param>
|
<param name="controllerContext">The controller context.</param>
|
<param name="actionMap">The action map.</param>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.Conventions.MetadataRoutingConvention.SelectController(System.Web.Http.OData.Routing.ODataPath,System.Net.Http.HttpRequestMessage)">
|
<summary>Selects the controller for OData requests.</summary>
|
<returns>null if the request isn't handled by this convention; otherwise, the name of the selected controller</returns>
|
<param name="odataPath">The OData path.</param>
|
<param name="request">The request.</param>
|
</member>
|
<member name="T:System.Web.Http.OData.Routing.Conventions.NavigationRoutingConvention">
|
<summary>An implementation of <see cref="T:System.Web.Http.OData.Routing.Conventions.IODataRoutingConvention" /> that handles navigation properties.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.Conventions.NavigationRoutingConvention.#ctor">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Routing.Conventions.NavigationRoutingConvention" /> class.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.Conventions.NavigationRoutingConvention.SelectAction(System.Web.Http.OData.Routing.ODataPath,System.Web.Http.Controllers.HttpControllerContext,System.Linq.ILookup{System.String,System.Web.Http.Controllers.HttpActionDescriptor})">
|
<summary>Selects the action.</summary>
|
<param name="odataPath">The odata path.</param>
|
<param name="controllerContext">The controller context.</param>
|
<param name="actionMap">The action map.</param>
|
</member>
|
<member name="T:System.Web.Http.OData.Routing.Conventions.ODataRoutingConventions">
|
<summary>Provides helper methods for creating routing conventions.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.Conventions.ODataRoutingConventions.CreateDefault">
|
<summary>Creates a mutable list of the default OData routing conventions.</summary>
|
<returns>A mutable list of the default OData routing conventions.</returns>
|
</member>
|
<member name="T:System.Web.Http.OData.Routing.Conventions.UnmappedRequestRoutingConvention">
|
<summary>An implementation of <see cref="T:System.Web.Http.OData.Routing.Conventions.IODataRoutingConvention" /> that always selects the action named HandleUnmappedRequest if that action is present.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.Conventions.UnmappedRequestRoutingConvention.#ctor">
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Http.OData.Routing.Conventions.UnmappedRequestRoutingConvention" /> class.</summary>
|
</member>
|
<member name="M:System.Web.Http.OData.Routing.Conventions.UnmappedRequestRoutingConvention.SelectAction(System.Web.Http.OData.Routing.ODataPath,System.Web.Http.Controllers.HttpControllerContext,System.Linq.ILookup{System.String,System.Web.Http.Controllers.HttpActionDescriptor})">
|
<summary>Selects the action.</summary>
|
<param name="odataPath">The odata path.</param>
|
<param name="controllerContext">The controller context.</param>
|
<param name="actionMap">The action map.</param>
|
</member>
|
</members>
|
</doc>
|