Article
11/18/2011

WebInvokeAttribute Class

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Indicates an operation is logically an invoke operation and that it can be called by the Web HTTP programming.

Inheritance Hierarchy

System.Object
System.Attribute
System.ServiceModel.Web.WebInvokeAttribute

Namespace: System.ServiceModel.Web
Assembly: System.ServiceModel.Web.Extensions (in System.ServiceModel.Web.Extensions.dll)

Syntax

'Declaration
<AttributeUsageAttribute(AttributeTargets.Method)> _
Public NotInheritable Class WebInvokeAttribute _
    Inherits Attribute _
    Implements IOperationBehavior

[AttributeUsageAttribute(AttributeTargets.Method)]
public sealed class WebInvokeAttribute : Attribute, 
    IOperationBehavior

The WebInvokeAttribute type exposes the following members.

Constructors

	Name	Description
	WebInvokeAttribute	Initializes a new instance of the WebGetAttribute class.

Top

Properties

	Name	Description
	BodyStyle	Gets and sets the body style of the messages that are sent to and from an 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 an 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 an operation.

Top

Methods

	Name	Description
	Equals	Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Returns the hash code for this instance. (Inherited from Attribute.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Match	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

	Name	Description
	IOperationBehavior.AddBindingParameters	Implements the AddBindingParameters(OperationDescription, BindingParameterCollection) method.
	IOperationBehavior.ApplyClientBehavior	Implements the ApplyClientBehavior(OperationDescription, ClientOperation) method.
	IOperationBehavior.ApplyDispatchBehavior	Implements the ApplyDispatchBehavior(OperationDescription, DispatchOperation) method.
	IOperationBehavior.Validate	Implements the Validate(OperationDescription) method.

Top

Remarks

The WebInvokeAttribute attribute is applied to an 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 an operation has no effect unless a behavior that looks for this metadata in the operation description (such as WebHttpBehavior) is added to the behavior collection. The WebInvokeAttribute determines what HTTP method that an 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 an operation to respond to GET, use the WebGetAttribute instead.

Examples

The following example shows how to use the WebInvokeAttribute attribute.

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

Version Information

Silverlight

Supported in: 5, 4

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

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.

Partager via