Share via

ActionConfiguration Class

  • Article

 

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)

Inheritance Hierarchy

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

Syntax

public class ActionConfiguration : ProcedureConfiguration

public ref class ActionConfiguration : ProcedureConfiguration

type ActionConfiguration = 
    class
        inherit ProcedureConfiguration
    end

Public Class ActionConfiguration
    Inherits ProcedureConfiguration

Properties

Name Description
System_CAPS_pubproperty BindingParameter

Get the bindingParameter.

Remarks

Null means the Action has no bindingParameter.
System_CAPS_pubproperty ContainerQualifiedName

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_pubproperty EntitySet

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

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

The FullName is the ContainerQualifiedName. (Inherited from ProcedureConfiguration.)
System_CAPS_pubproperty 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.)
System_CAPS_pubproperty IsAlwaysBindable

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_pubproperty IsBindable

(Overrides ProcedureConfiguration.IsBindable.)
System_CAPS_pubproperty IsComposable

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_pubproperty IsSideEffecting

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

(Overrides ProcedureConfiguration.Kind.)
System_CAPS_protproperty ModelBuilder

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

The Name of the procedure (Inherited from ProcedureConfiguration.)
System_CAPS_pubproperty Parameters

(Overrides ProcedureConfiguration.Parameters.)
System_CAPS_pubproperty ReturnType

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

Methods

Name Description
System_CAPS_pubmethod AddParameter(String, IEdmTypeConfiguration)

Adds a new non-binding parameter.
System_CAPS_pubmethod CollectionParameter<TElementType>(String)

Adds a new non-binding collection parameter
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)
System_CAPS_protmethod Finalize()

(Inherited from Object.)
System_CAPS_pubmethod GetActionLink()

Retrieves the currently registered action link factory.
System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)
System_CAPS_pubmethod GetType()

(Inherited from Object.)
System_CAPS_pubmethod HasActionLink(Func<EntityInstanceContext, Uri>, Boolean)

Register a factory that creates actions links.
System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)
System_CAPS_pubmethod Parameter<TParameter>(String)

Adds a new non-binding parameter
System_CAPS_pubmethod Returns<TReturnType>()

Established the return type of the Action.

Remarks

Used when the return type is a single Primitive or ComplexType.
System_CAPS_pubmethod ReturnsCollection<TReturnElementType>()

Establishes the return type of the Action

Remarks

Used when the return type is a collection of either Primitive or ComplexTypes.
System_CAPS_pubmethod ReturnsCollectionFromEntitySet<TElementEntityType>(EntitySetConfiguration<TElementEntityType>)

Sets the return type to a collection of entities.
System_CAPS_pubmethod ReturnsCollectionFromEntitySet<TElementEntityType>(String)

Sets the return type to a collection of entities.
System_CAPS_pubmethod ReturnsFromEntitySet<TEntityType>(EntitySetConfiguration<TEntityType>)

Sets the return type to a single EntityType instance.
System_CAPS_pubmethod ReturnsFromEntitySet<TEntityType>(String)

Sets the return type to a single EntityType instance.
System_CAPS_pubmethod SetBindingParameter(String, IEdmTypeConfiguration, Boolean)

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

(Inherited from Object.)

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.

See Also

System.Web.Http.OData.Builder Namespace

Return to top