ActionConfiguration Class

 

ActionConfiguration represents an OData action that you wish to expose via your service.

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

System::Object
  System.Web.Http.OData.Builder::ProcedureConfiguration
    System.Web.Http.OData.Builder::ActionConfiguration

public ref class ActionConfiguration : ProcedureConfiguration

NameDescription
System_CAPS_pubpropertyBindingParameter

Get the bindingParameter.

Null means the Action has no bindingParameter.

System_CAPS_pubpropertyContainerQualifiedName

The qualified name of the procedure when used in OData urls. Qualification is required to distinguish the procedure from other possible single part identifiers. (Inherited from ProcedureConfiguration.)

System_CAPS_pubpropertyEntitySet

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

System_CAPS_pubpropertyFollowsConventions

Gets a value indicating whether links provided by GetActionLink follow OData conventions.

System_CAPS_pubpropertyFullName

The FullName is the ContainerQualifiedName. (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_pubpropertyIsAlwaysBindable

Whether this action can always be bound.

For example imagine an 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.
(Overrides ProcedureConfiguration::IsAlwaysBindable.)

System_CAPS_pubpropertyIsBindable
System_CAPS_pubpropertyIsComposable

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 (Inherited from ProcedureConfiguration.)

System_CAPS_pubpropertyIsSideEffecting

Does the procedure have side-effects. (Inherited from ProcedureConfiguration.)

System_CAPS_pubpropertyKind
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_pubpropertyParameters
System_CAPS_pubpropertyReturnType

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

NameDescription
System_CAPS_pubmethodAddParameter(String^, IEdmTypeConfiguration^)

Adds a new non-binding parameter.

System_CAPS_pubmethodCollectionParameter<TElementType>(String^)

Adds a new non-binding collection parameter

System_CAPS_pubmethodEquals(Object^)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetActionLink()

Retrieves the currently registered action link factory.

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

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

Register a factory that creates actions links.

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodParameter<TParameter>(String^)

Adds a new non-binding parameter

System_CAPS_pubmethodReturns<TReturnType>()

Established the return type of the Action.

Used when the return type is a single Primitive or ComplexType.

System_CAPS_pubmethodReturnsCollection<TReturnElementType>()

Establishes the return type of the Action

Used when the return type is a collection of either Primitive or ComplexTypes.

System_CAPS_pubmethodReturnsCollectionFromEntitySet<TElementEntityType>(EntitySetConfiguration<TElementEntityType>^)

Sets the return type to a collection of entities.

System_CAPS_pubmethodReturnsCollectionFromEntitySet<TElementEntityType>(String^)

Sets the return type to a collection of entities.

System_CAPS_pubmethodReturnsFromEntitySet<TEntityType>(EntitySetConfiguration<TEntityType>^)

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^, Boolean)

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

System_CAPS_pubmethodToString()

(Inherited from Object.)

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: