FunctionConfiguration Class

Article
10/28/2015

FunctionConfiguration represents an OData function that you wish to expose via your service.

Namespace: System.Web.OData.Builder
Assembly: System.Web.OData (in System.Web.OData.dll)

Inheritance Hierarchy

System.Object
System.Web.OData.Builder.ProcedureConfiguration
System.Web.OData.Builder.FunctionConfiguration

Syntax

public class FunctionConfiguration : ProcedureConfiguration

public ref class FunctionConfiguration : ProcedureConfiguration

type FunctionConfiguration = 
    class
        inherit ProcedureConfiguration
    end

Public Class FunctionConfiguration
    Inherits ProcedureConfiguration

Properties

	Name	Description
	BindingParameter	Gets the binding parameter.(Inherited from ProcedureConfiguration.)
	EntitySetPath	The EntitySetPathExpression that entities are returned from.(Inherited from ProcedureConfiguration.)
	FollowsConventions	Gets a value indicating whether procedure links follow OData conventions.(Inherited from ProcedureConfiguration.)
	FullyQualifiedName	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.(Inherited from ProcedureConfiguration.)
	IncludeInServiceDocument	Gets or sets a value indicating whether the procedure is included in service document or not. Meaningful only for function imports; ignore for bound functions.
	IsBindable	Can the procedure be bound to a url representing the BindingParameter.(Inherited from ProcedureConfiguration.)
	IsComposable
	IsSideEffecting	(Overrides ProcedureConfiguration.IsSideEffecting.)
	Kind	(Overrides ProcedureConfiguration.Kind.)
	LinkFactory	Gets or sets the currently registered procedure link factory.(Inherited from ProcedureConfiguration.)
	ModelBuilder	Gets or sets the ODataModelBuilder used to create this configuration.(Inherited from ProcedureConfiguration.)
	Name	The Name of the procedure(Inherited from ProcedureConfiguration.)
	Namespace	The Namespace by default is the ModelBuilder's Namespace. (Inherited from ProcedureConfiguration.)
	NavigationSource	The Navigation Source that are returned from.(Inherited from ProcedureConfiguration.)
	OptionalReturn	Gets or sets a value indicating whether the return is optional or not. (Inherited from ProcedureConfiguration.)
	Parameters	The parameters the procedure takes(Inherited from ProcedureConfiguration.)
	ReturnType	The type returned when the procedure is invoked.(Inherited from ProcedureConfiguration.)
	SupportedInFilter	Gets and sets a value indicating whether the function is supported in $filter.
	SupportedInOrderBy	Gets and sets a value indicating whether the function is supported in $orderby.
	Title	The Title of the procedure. When customized, the title of the procedure will be sent back when the OData client asks for an entity or a feed in JSON full metadata.(Inherited from ProcedureConfiguration.)

Methods

	Name	Description
	AddParameter(String, IEdmTypeConfiguration)	Adds a new non-binding parameter.(Inherited from ProcedureConfiguration.)
	CollectionEntityParameter<TElementEntityType>(String)	Adds a new non-binding collection of entity type parameter. (Inherited from ProcedureConfiguration.)
	CollectionParameter<TElementType>(String)	Adds a new non-binding collection parameter(Inherited from ProcedureConfiguration.)
	EntityParameter<TEntityType>(String)	Adds a new non-binding entity type parameter. (Inherited from ProcedureConfiguration.)
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetFunctionLink()	Retrieves the currently registered function link factory.
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	HasFunctionLink(Func<EntityInstanceContext, Uri>, Boolean)	Register a factory that creates functions links.
	MemberwiseClone()	(Inherited from Object.)
	Parameter<TParameter>(String)	Adds a new non-binding parameter(Inherited from ProcedureConfiguration.)
	Returns<TReturnType>()	Establishes the return type of the Function.
	ReturnsCollection<TReturnElementType>()	Establishes the return type of the Function
	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".
	ToString()	(Inherited from Object.)

Remarks

FunctionConfigurations are exposed via $metadata as a FunctionImport element.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via