FunctionConfiguration Class

 

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)

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

public ref class FunctionConfiguration : ProcedureConfiguration

NameDescription
System_CAPS_pubpropertyBindingParameter

Gets the binding parameter.(Inherited from ProcedureConfiguration.)

System_CAPS_pubpropertyEntitySetPath

The EntitySetPathExpression that entities are returned from.(Inherited from ProcedureConfiguration.)

System_CAPS_pubpropertyFollowsConventions

Gets a value indicating whether procedure links follow OData conventions.(Inherited from ProcedureConfiguration.)

System_CAPS_pubpropertyFullyQualifiedName

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

System_CAPS_pubpropertyIncludeInServiceDocument

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.

System_CAPS_pubpropertyIsBindable

Can the procedure be bound to a url representing the BindingParameter.(Inherited from ProcedureConfiguration.)

System_CAPS_pubpropertyIsComposable

System_CAPS_pubpropertyIsSideEffecting
System_CAPS_pubpropertyKind
System_CAPS_protpropertyLinkFactory

Gets or sets the currently registered procedure link factory.(Inherited from ProcedureConfiguration.)

System_CAPS_protpropertyModelBuilder

Gets or sets the ODataModelBuilder used to create this configuration.(Inherited from ProcedureConfiguration.)

System_CAPS_pubpropertyName

The Name of the procedure(Inherited from ProcedureConfiguration.)

System_CAPS_pubpropertyNamespace

The Namespace by default is the ModelBuilder's Namespace. (Inherited from ProcedureConfiguration.)

System_CAPS_pubpropertyNavigationSource

The Navigation Source that are returned from.(Inherited from ProcedureConfiguration.)

System_CAPS_pubpropertyOptionalReturn

Gets or sets a value indicating whether the return is optional or not. (Inherited from ProcedureConfiguration.)

System_CAPS_pubpropertyParameters

The parameters the procedure takes(Inherited from ProcedureConfiguration.)

System_CAPS_pubpropertyReturnType

The type returned when the procedure is invoked.(Inherited from ProcedureConfiguration.)

System_CAPS_pubpropertySupportedInFilter

Gets and sets a value indicating whether the function is supported in $filter.

System_CAPS_pubpropertySupportedInOrderBy

Gets and sets a value indicating whether the function is supported in $orderby.

System_CAPS_pubpropertyTitle

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

NameDescription
System_CAPS_pubmethodAddParameter(String^, IEdmTypeConfiguration^)

Adds a new non-binding parameter.(Inherited from ProcedureConfiguration.)

System_CAPS_pubmethodCollectionEntityParameter<TElementEntityType>(String^)

Adds a new non-binding collection of entity type parameter. (Inherited from ProcedureConfiguration.)

System_CAPS_pubmethodCollectionParameter<TElementType>(String^)

Adds a new non-binding collection parameter(Inherited from ProcedureConfiguration.)

System_CAPS_pubmethodEntityParameter<TEntityType>(String^)

Adds a new non-binding entity type parameter. (Inherited from ProcedureConfiguration.)

System_CAPS_pubmethodEquals(Object^)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetFunctionLink()

Retrieves the currently registered function link factory.

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodHasFunctionLink(Func<EntityInstanceContext^, Uri^>^, Boolean)

Register a factory that creates functions links.

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodParameter<TParameter>(String^)

Adds a new non-binding parameter(Inherited from ProcedureConfiguration.)

System_CAPS_pubmethodReturns<TReturnType>()

Establishes the return type of the Function.

System_CAPS_pubmethodReturnsCollection<TReturnElementType>()

Establishes the return type of the Function

System_CAPS_pubmethodReturnsCollectionFromEntitySet<TElementEntityType>(String^)

Sets the return type to a collection of EntityType instances.

System_CAPS_pubmethodReturnsCollectionViaEntitySetPath<TElementEntityType>(String^)

Sets the return type to a collection of EntityType instances.

System_CAPS_pubmethodReturnsCollectionViaEntitySetPath<TElementEntityType>(array<String^>^)

Sets the return type to a collection of EntityType instances.

System_CAPS_pubmethodReturnsEntityViaEntitySetPath<TEntityType>(String^)

Sets the return type to a single EntityType instance.

System_CAPS_pubmethodReturnsEntityViaEntitySetPath<TEntityType>(array<String^>^)

Sets the return type to a single EntityType instance.

System_CAPS_pubmethodReturnsFromEntitySet<TEntityType>(String^)

Sets the return type to a single EntityType instance.

System_CAPS_pubmethodSetBindingParameter(String^, IEdmTypeConfiguration^)

Specifies the bindingParameter name, type and whether it is alwaysBindable, use only if the Function "isBindable".

System_CAPS_pubmethodToString()

(Inherited from Object.)

FunctionConfigurations are exposed via $metadata as a FunctionImport element.

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

Return to top
Show: