WebInvokeAttribute Class

Definition

Represents an attribute indicating that a service operation is logically an invoke operation and that it can be called by the WCF REST programming model.

[System.AttributeUsage(System.AttributeTargets.Method)]
public sealed class WebInvokeAttribute : Attribute, System.ServiceModel.Description.IOperationBehavior
Inheritance
WebInvokeAttribute
Attributes
Implements

Examples

The following example shows how to use the WebInvokeAttribute attribute.

Note

Because the Method property is not specified in the following code, all service operations are mapped to the HTTP POST method.

[ServiceContract]
public interface ICalculator2
{
    [OperationContract]
    [WebInvoke]
    long Add(long x, long y);

    [OperationContract]
    [WebInvoke(UriTemplate = "Sub?x={x}&y={y}")]
    long Subtract(long x, long y);

    [OperationContract]
    [WebInvoke(UriTemplate = "Mult?x={x}&y={y}", BodyStyle = WebMessageBodyStyle.Bare)]
    long Multiply(long x, long y);

    [OperationContract]
    [WebInvoke(UriTemplate = "Div?x={x}&y={y}", BodyStyle = WebMessageBodyStyle.Bare, RequestFormat = WebMessageFormat.Xml, ResponseFormat=WebMessageFormat.Xml)]
    long Divide(long x, long y);

    [OperationContract]
    [WebInvoke(Method = "POST", UriTemplate = "Mod?x={x}&y={y}")]
    long Mod(long x, long y);
}
<ServiceContract()> _
Public Interface ICalculator2
    <OperationContract()> _
    <WebInvoke()> _
    Function Add(ByVal x As Long, ByVal y As Long) As Long

    <OperationContract()> _
    <WebInvoke(UriTemplate:="Sub?x={x}&y={y}")> _
    Function Subtract(ByVal x As Long, ByVal y As Long) As Long

    <OperationContract()> _
    <WebInvoke(UriTemplate:="Mult?x={x}&y={y}", BodyStyle:=WebMessageBodyStyle.Bare)> _
    Function Multiply(ByVal x As Long, ByVal y As Long) As Long

    <OperationContract()> _
    <WebInvoke(UriTemplate:="Div?x={x}&y={y}", BodyStyle:=WebMessageBodyStyle.Bare, RequestFormat:=WebMessageFormat.Xml, ResponseFormat:=WebMessageFormat.Xml)> _
    Function Divide(ByVal x As Long, ByVal y As Long) As Long

    <OperationContract()> _
   <WebInvoke(Method:="POST", UriTemplate:="Mod?x={x}&y={y}")> _
   Function Modulo(ByVal x As Long, ByVal y As Long) As Long
End Interface

Remarks

The WebInvokeAttribute attribute is applied to a service operation in addition to the OperationContractAttribute and associates the operation with a UriTemplate as well as an underlying transport verb that represents an invocation (for example, HTTP POST, PUT, or DELETE). The WebInvokeAttribute attribute is a passive operation behavior (the IOperationBehavior methods do nothing) that adds metadata to the operation description. Applying the WebInvokeAttribute attribute to a service operation has no effect unless a behavior that looks for this metadata in the operation description (such as WebHttpBehavior) is added to the service's behavior collection. The WebInvokeAttribute determines what HTTP method that a service operation responds to. By default, all methods that have the WebInvokeAttribute applied respond to POST requests. The Method property allows you to specify a different HTTP method. If you want a service operation to respond to GET, use the WebGetAttribute instead.

Constructors

WebInvokeAttribute()

Initializes a new instance of the WebInvokeAttribute class.

Properties

BodyStyle

Gets and sets the body style of the messages that are sent to and from the service operation.

IsBodyStyleSetExplicitly

Gets the IsBodyStyleSetExplicitly property.

IsRequestFormatSetExplicitly

Gets the IsRequestFormatSetExplicitly property.

IsResponseFormatSetExplicitly

Gets the IsResponseFormatSetExplicitly property.

Method

Gets and sets the protocol (for example HTTP) method the service operation responds to.

RequestFormat

Gets and sets the RequestFormat property.

ResponseFormat

Gets and sets the ResponseFormat property.

UriTemplate

The Uniform Resource Identifier (URI) template for the service operation.

Explicit Interface Implementations

IOperationBehavior.AddBindingParameters(OperationDescription, BindingParameterCollection)

Implements the AddBindingParameters(OperationDescription, BindingParameterCollection) method.

IOperationBehavior.ApplyClientBehavior(OperationDescription, ClientOperation)

Implements the ApplyClientBehavior(OperationDescription, ClientOperation) method.

IOperationBehavior.ApplyDispatchBehavior(OperationDescription, DispatchOperation)

Implements the ApplyDispatchBehavior(OperationDescription, DispatchOperation) method.

IOperationBehavior.Validate(OperationDescription)

Implements the Validate(OperationDescription) method.

Methods

Equals(Object) Inherited from Attribute
GetCustomAttribute(Assembly, Type) Inherited from Attribute
GetCustomAttribute(Assembly, Type, Boolean) Inherited from Attribute
GetCustomAttribute(MemberInfo, Type) Inherited from Attribute
GetCustomAttribute(MemberInfo, Type, Boolean) Inherited from Attribute
GetCustomAttribute(Module, Type) Inherited from Attribute
GetCustomAttribute(Module, Type, Boolean) Inherited from Attribute
GetCustomAttribute(ParameterInfo, Type) Inherited from Attribute
GetCustomAttribute(ParameterInfo, Type, Boolean) Inherited from Attribute
GetCustomAttributes(Assembly) Inherited from Attribute
GetCustomAttributes(Assembly, Boolean) Inherited from Attribute
GetCustomAttributes(Assembly, Type) Inherited from Attribute
GetCustomAttributes(Assembly, Type, Boolean) Inherited from Attribute
GetCustomAttributes(MemberInfo) Inherited from Attribute
GetCustomAttributes(MemberInfo, Boolean) Inherited from Attribute
GetCustomAttributes(MemberInfo, Type) Inherited from Attribute
GetCustomAttributes(MemberInfo, Type, Boolean) Inherited from Attribute
GetCustomAttributes(Module) Inherited from Attribute
GetCustomAttributes(Module, Boolean) Inherited from Attribute
GetCustomAttributes(Module, Type) Inherited from Attribute
GetCustomAttributes(Module, Type, Boolean) Inherited from Attribute
GetCustomAttributes(ParameterInfo) Inherited from Attribute
GetCustomAttributes(ParameterInfo, Boolean) Inherited from Attribute
GetCustomAttributes(ParameterInfo, Type) Inherited from Attribute
GetCustomAttributes(ParameterInfo, Type, Boolean) Inherited from Attribute
GetHashCode() Inherited from Attribute
IsDefaultAttribute() Inherited from Attribute
IsDefined(Assembly, Type) Inherited from Attribute
IsDefined(Assembly, Type, Boolean) Inherited from Attribute
IsDefined(MemberInfo, Type) Inherited from Attribute
IsDefined(MemberInfo, Type, Boolean) Inherited from Attribute
IsDefined(Module, Type) Inherited from Attribute
IsDefined(Module, Type, Boolean) Inherited from Attribute
IsDefined(ParameterInfo, Type) Inherited from Attribute
IsDefined(ParameterInfo, Type, Boolean) Inherited from Attribute
Match(Object) Inherited from Attribute
_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) Inherited from Attribute
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) Inherited from Attribute
_Attribute.GetTypeInfoCount(UInt32) Inherited from Attribute
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) Inherited from Attribute
TypeId Inherited from Attribute
Equals(Object, Object) Inherited from Object
GetType() Inherited from Object
MemberwiseClone() Inherited from Object
ReferenceEquals(Object, Object) Inherited from Object
ToString() Inherited from Object

Applies to