FunctionConfiguration Class

Definition

Namespace:

Microsoft.AspNet.OData.Builder

Assembly:

Microsoft.AspNetCore.OData.dll

Package:

Microsoft.AspNetCore.OData v7.5.8

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.

public class FunctionConfiguration : Microsoft.AspNet.OData.Builder.OperationConfiguration

type FunctionConfiguration = class
    inherit OperationConfiguration

Public Class FunctionConfiguration
Inherits OperationConfiguration

Inheritance

Object

OperationConfiguration

FunctionConfiguration

Properties

BindingParameter	Get the bindingParameter. Null means the operation has no bindingParameter. (Inherited from OperationConfiguration)
EntitySetPath	The EntitySetPathExpression that entities are returned from. (Inherited from OperationConfiguration)
FollowsConventions	Gets a value indicating whether operation links follow OData conventions. (Inherited from OperationConfiguration)
FullyQualifiedName	The FullyQualifiedName is the Name further qualified using the Namespace. (Inherited from OperationConfiguration)
IncludeInServiceDocument	Gets/Set a value indicating whether the operation is included in service document or not. Meaningful only for function imports; ignore for bound functions.
IsBindable	Can the operation be bound to a URL representing the BindingParameter. (Inherited from OperationConfiguration)
IsComposable	Can the operation be composed upon. For example can a URL that invokes the operation be used as the base URL for a request that invokes the operation and does something else with the results
IsSideEffecting	Does the operation have side-effects.
Kind	The Kind of operation, which can be either Action or Function
ModelBuilder	Gets or sets the ODataModelBuilder used to create this configuration. (Inherited from OperationConfiguration)
Name	The Name of the operation (Inherited from OperationConfiguration)
Namespace	The Namespace by default is the ModelBuilder's Namespace. (Inherited from OperationConfiguration)
NavigationSource	The Navigation Source that are returned from. (Inherited from OperationConfiguration)
OperationLinkBuilder	Gets or sets the currently registered operation link builder. (Inherited from OperationConfiguration)
Parameters	The parameters the operation takes (Inherited from OperationConfiguration)
ReturnNullable	Gets or sets a value indicating whether the return is nullable or not. (Inherited from OperationConfiguration)
ReturnType	The type returned when the operation is invoked. (Inherited from OperationConfiguration)
ReturnTypeConstraints	Type constraints for the return type of the operation. (Inherited from OperationConfiguration)
SupportedInFilter	Gets/Sets a value indicating whether the function is supported in $filter.
SupportedInOrderBy	Gets/Sets a value indicating whether the function is supported in $orderby.
Title	The Title of the operation. When customized, the title of the operation will be sent back when the OData client asks for an entity or a feed in JSON full metadata. (Inherited from OperationConfiguration)

Methods

AddParameter(String, IEdmTypeConfiguration)	Adds a new non-binding parameter. (Inherited from OperationConfiguration)
CollectionEntityParameter(Type, String)	Adds a new non-binding collection of entity type parameter. (Inherited from OperationConfiguration)
CollectionEntityParameter<TElementEntityType>(String)	Adds a new non-binding collection of entity type parameter. (Inherited from OperationConfiguration)
CollectionParameter(Type, String)	Adds a new non-binding collection parameter (Inherited from OperationConfiguration)
CollectionParameter<TElementType>(String)	Adds a new non-binding collection parameter (Inherited from OperationConfiguration)
EntityParameter(Type, String)	Adds a new non-binding entity type parameter. (Inherited from OperationConfiguration)
EntityParameter<TEntityType>(String)	Adds a new non-binding entity type parameter. (Inherited from OperationConfiguration)
GetFeedFunctionLink()	Retrieves the currently registered feed function link factory.
GetFunctionLink()	Retrieves the currently registered function link factory.
HasDerivedTypeConstraintForReturnType<TDerivedType>()	Adds TDerived to the list of derived type constraints for the return type.
HasDerivedTypeConstraintsForReturnType(Type[])	Adds subtypes to the list of derived type constraints for the return type.
HasFeedFunctionLink(Func<ResourceSetContext,Uri>, Boolean)	Register a factory that creates feed functions links.
HasFunctionLink(Func<ResourceContext,Uri>, Boolean)	Register a factory that creates functions links.
Parameter(Type, String)	Adds a new non-binding parameter (Inherited from OperationConfiguration)
Parameter<TParameter>(String)	Adds a new non-binding parameter (Inherited from OperationConfiguration)
Returns(Type)	Established the return type of the Function. Used when the return type is a single Primitive or ComplexType.
Returns<TReturnType>()	Established the return type of the Function. Used when the return type is a single Primitive or ComplexType.
ReturnsCollection<TReturnElementType>()	Establishes the return type of the Function Used when the return type is a collection of either Primitive or ComplexTypes.
ReturnsCollectionFromEntitySet<TElementEntityType>(String)	Sets the return type to a collection of EntityType instances.
ReturnsCollectionViaEntitySetPath<TElementEntityType>(String)	Sets the return type to a collection of EntityType instances.
ReturnsCollectionViaEntitySetPath<TElementEntityType>(String[])	Sets the return type to a collection of EntityType instances.
ReturnsEntityViaEntitySetPath<TEntityType>(String)	Sets the return type to a single EntityType instance.
ReturnsEntityViaEntitySetPath<TEntityType>(String[])	Sets the return type to a single EntityType instance.
ReturnsFromEntitySet<TEntityType>(String)	Sets the return type to a single EntityType instance.
SetBindingParameter(String, IEdmTypeConfiguration)	Specifies the bindingParameter name, type and whether it is alwaysBindable, use only if the Function "isBindable".