Share via

ActionConfiguration Class

  • Article

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

Inheritance Hierarchy

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

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

Syntax

'Declaration
Public Class ActionConfiguration _
    Inherits ProcedureConfiguration
'Usage
Dim instance As ActionConfiguration

public class ActionConfiguration : ProcedureConfiguration

public ref class ActionConfiguration : public ProcedureConfiguration

type ActionConfiguration =  
    class 
        inherit ProcedureConfiguration 
    end

public class ActionConfiguration extends ProcedureConfiguration

The ActionConfiguration type exposes the following members.

Properties

  Name Description
Public property BindingParameter Get the bindingParameter.
Public property ContainerQualifiedName Gets 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.)
Public property EntitySet Gets or sets the EntitySet that entities are returned from. (Inherited from ProcedureConfiguration.)
Public property FollowsConventions Gets a value indicating whether links provided by GetActionLink() follow OData conventions.
Public property FullName Gets the FullName that is the ContainerQualifiedName. (Inherited from ProcedureConfiguration.)
Public property FullyQualifiedName Gets 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.)
Public property IsAlwaysBindable Whether this action can always be bound. For example, imagine a 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.)
Public property IsBindable Gets a value whether the action can be found to a url representing the BindingParameter. (Overrides ProcedureConfiguration.IsBindable.)
Public property 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.)
Public property IsSideEffecting Does the procedure have side-effects. (Inherited from ProcedureConfiguration.)
Public property Kind Gets the Kind of procedure, which can be either Action, Function or ServiceOperation. (Overrides ProcedureConfiguration.Kind.)
Protected property ModelBuilder Gets or sets the associated ODataModelBuilder. (Inherited from ProcedureConfiguration.)
Public property Name Gets or sets the Name of the procedure. (Inherited from ProcedureConfiguration.)
Public property Parameters Gets the parameters the action takes. (Overrides ProcedureConfiguration.Parameters.)
Public property ReturnType Gets or sets the type returned when the procedure is invoked. (Inherited from ProcedureConfiguration.)

Top

Methods

  Name Description
Public method AddParameter Adds a new non-binding parameter.
Public method CollectionParameter<TElementType> Adds a new non-binding collection parameter.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetActionLink Retrieves the currently registered action link factory.
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Public method HasActionLink Register a factory that creates actions links.
Protected method MemberwiseClone (Inherited from Object.)
Public method Parameter<TParameter> Adds a new non-binding parameter.
Public method Returns<TReturnType> Established the return type of the Action.
Public method ReturnsCollection<TReturnElementType> Establishes the return type of the Action Used when the return type is a collection of either Primitive or ComplexTypes.
Public method ReturnsCollectionFromEntitySet<TElementEntityType>(String) Sets the return type to a collection of EntityType instances.
Public method ReturnsCollectionFromEntitySet<TElementEntityType>(EntitySetConfiguration<TElementEntityType>) Sets the return type to a collection of entities.
Public method ReturnsFromEntitySet<TEntityType>(String) Sets the return type to a single EntityType instance.
Public method ReturnsFromEntitySet<TEntityType>(EntitySetConfiguration<TEntityType>) Sets the return type to a single EntityType instance.
Public method SetBindingParameter Specifies the bindingParameter name, type and whether it is alwaysBindable, use only if the Action "isBindable".
Public method ToString (Inherited from Object.)

Top

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

Reference

System.Web.Http.OData.Builder Namespace