Microsoft.AspNet.OData.Builder Namespace

Classes

ActionConfiguration

ActionConfiguration represents an OData action that you wish to expose via your service. ActionConfigurations are exposed via $metadata as a element for bound action and element for unbound action.

ActionOnDeleteAttribute

Represents an Attribute that can be placed on a navigation property to specify the applied action whether delete should also remove the associated item on the other end of the association.

AutoExpandAttribute

Represents an Attribute that can be placed on a navigation property to specify it is auto expanded, or placed on a class to specify all navigation properties are auto expanded.

BindingParameterConfiguration

Represents a BindingParameter. Actions/Functions can have at most one BindingParameter. This parameter has similar semantics to the 'this' keyword in C# extensions methods.

For example given a url that identifies a Movie, if there is an action that has a bindingParameter that is a Movie, you can bind the Action to the url.

i.e. if ~/Movies(1) identifies a Movie, and there exists a Checkout action that has a Movie BindingParameter, you can invoke that Action at this url ~/Movies(1)/Checkout

The BindingParameter type must either be an EntityType or a Collection of EntityTypes.
BindingPathConfiguration<TStructuralType>

Represents the configuration for the binding path that can be built using ODataModelBuilder. The structural type of the current binding path property.

CollectionPropertyConfiguration

CollectionPropertyConfiguration represents a CollectionProperty on either an EntityType or ComplexType.

CollectionTypeConfiguration

Represents a Collection of some named type. Collection(Namespace.Customer) or Collection(Namespace.Address).

ComplexPropertyConfiguration

Represents the configuration for a complex property of a structural type (an entity type or a complex type).

ComplexTypeConfiguration

Allows configuration to be performed for a complex type in a model. A ComplexTypeConfiguration can be obtained by using the method ComplexType<TComplexType>().

ComplexTypeConfiguration<TComplexType>

Represents an IEdmComplexType that can be built using ODataModelBuilder.

ContainedAttribute

Mark a navigation property as containment.

DecimalPropertyConfiguration

Used to configure a decimal property of an entity type or complex type. This configuration functionality is exposed by the model builder Fluent API, see ODataModelBuilder.

DerivedTypeConstraintAttribute

Represents an Attribute that can be placed on a property or placed on a class to specify the derived type constraints.

DerivedTypeConstraintConfiguration

Configuration for derived type constraints.

DynamicPropertyDictionaryAnnotation

This annotation indicates the mapping from a IEdmStructuredType to a PropertyInfo. The IEdmStructuredType is an open type and the PropertyInfo is the specific property which is used in an open type to save/retrieve the dynamic properties.

EntityCollectionConfiguration<TEntityType>

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.

EntitySetConfiguration

Allows configuration to be performed for an entity set in a model. A EntitySetConfiguration can be obtained by using the method EntitySet<TEntityType>(String).

EntitySetConfiguration<TEntityType>

Represents an IEdmEntitySet that can be built using ODataModelBuilder. The element type of the entity set.

EntityTypeConfiguration

Represents an IEdmEntityType that can be built using ODataModelBuilder.

EntityTypeConfiguration<TEntityType>

Represents an IEdmEntityType that can be built using ODataModelBuilder.

EnumMemberConfiguration

Represents the configuration for an enum member of an enum type.

EnumPropertyConfiguration

Used to configure an enum property of an entity type or complex type. This configuration functionality is exposed by the model builder Fluent API, see ODataModelBuilder.

EnumTypeConfiguration

Represents an IEdmEnumType that can be built using ODataModelBuilder.

EnumTypeConfiguration<TEnumType>

Represents an IEdmEnumType that can be built using ODataModelBuilder.

FunctionConfiguration

FunctionConfiguration represents an OData function that you wish to expose via your service. FunctionConfigurations are exposed via $metadata as a element for bound function and element for unbound function.

LengthPropertyConfiguration

Used to configure a string or binary property length of an entity type or complex type. This configuration functionality is exposed by the model builder Fluent API, see ODataModelBuilder.

LinkGenerationHelpers

Contains helper methods for generating OData links that follow OData URL conventions.

LowerCamelCaser

Default lower camel caser to resolve property names for ODataConventionModelBuilder. The rule is to convert the leading upper case characters to lower case, until a character, which is not the first character and is followed by a non-upper case character, is met. id => id, ID => id, MyName => myName, IOStream => ioStream, MyID => myid, yourID => yourID

MediaTypeAttribute

Marks this entity type as media type.

NavigationLinkBuilder

Encapsulates a navigation link factory and whether the link factory follows conventions or not.

NavigationPropertyBindingConfiguration

Used to configure the binding for a navigation property for a navigation source. This configuration functionality is exposed by the model builder Fluent API, see ODataModelBuilder.

NavigationPropertyConfiguration

Represents the configuration for a navigation property of a structural type.

NavigationSourceConfiguration

Allows configuration to be performed for a navigation source (entity set, singleton) in a model.

NavigationSourceConfiguration<TEntityType>

Represents an IEdmNavigationSource that can be built using ODataModelBuilder. The entity type of the navigation source.

NavigationSourceLinkBuilderAnnotation

NavigationSourceLinkBuilderAnnotation is a class used to annotate an IEdmNavigationSource inside an IEdmModel with information about how to build links related to that navigation source.

NonbindingParameterConfiguration

Represents a non-binding operation 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).
ODataConventionModelBuilder

ODataConventionModelBuilder is used to automatically map CLR classes to an EDM model based on a set of.

ODataConventionModelBuilderExtensions

Provides extension methods for the ODataConventionModelBuilder class.

ODataInstanceAnnotationContainer

Intended as Default implementation for IODataInstanceAnnotationContainer

ODataModelBuilder

ODataModelBuilder is used to map CLR classes to an EDM model.

OperationConfiguration

Represents a Operation that is exposed in the model

OperationLinkBuilder

OperationLinkBuilder can be used to annotate an action or a function. This is how formatters create links to invoke bound actions or functions.

ParameterConfiguration

Represents a parameter to a Operation

PrecisionPropertyConfiguration

Used to configure a datetime-with-offset, decimal, duration, or time-of-day property precision of an entity type or complex type. This configuration functionality is exposed by the model builder Fluent API, see ODataModelBuilder.

PrimitivePropertyConfiguration

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

PrimitivePropertyConfigurationExtensions

Extensions method for PrimitivePropertyConfiguration.

PrimitiveTypeConfiguration

Represents a PrimitiveType

PropertyConfiguration

Base class for all property configurations.

QueryConfiguration

Query configuration which contains ModelBoundQuerySettings.

SelfLinkBuilder<T>

Encapsulates a self link factory and whether the link factory follows conventions or not.

SingletonAttribute

Represents an Attribute that can be placed on a property to specify that the property must bind to a singleton. It's used in convention model builder.

SingletonConfiguration

Allows configuration to be performed for a singleton in a model. A SingletonConfiguration can be obtained by using the method Singletons.

SingletonConfiguration<TEntityType>

Represents an IEdmSingleton that can be built using ODataModelBuilder.

StructuralPropertyConfiguration

Base class for all structural property configurations.

StructuralTypeConfiguration

Represents an IEdmStructuredType that can be built using ODataModelBuilder.

StructuralTypeConfiguration<TStructuralType>

Represents an IEdmStructuredType that can be built using ODataModelBuilder.

Interfaces

IEdmTypeConfiguration

Represents an EdmType

IODataInstanceAnnotationContainer

Interface to used as a Container for holding Instance Annotations, An default implementation is provided Custoer can implement the interface and can have their own implementation.

Enums

NameResolverOptions

Options for resolving names.

NavigationPropertyBindingOption

Options for navigation property binding.

OperationKind

The Kind of OData Operation. One of Action, Function or ServiceOperation.

PropertyKind

The kind of the EDM property.