WebGetAttribute Class

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

Inheritance Hierarchy

System.Object
  System.Attribute
    System.ServiceModel.Web.WebGetAttribute

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

Syntax

'Declaration
<AttributeUsageAttribute(AttributeTargets.Method)> _
Public NotInheritable Class WebGetAttribute _
    Inherits Attribute _
    Implements IOperationBehavior
[AttributeUsageAttribute(AttributeTargets.Method)]
public sealed class WebGetAttribute : Attribute, 
    IOperationBehavior

The WebGetAttribute type exposes the following members.

Constructors

  Name Description
Public method WebGetAttribute Initializes a new instance of the WebGetAttribute class.

Top

Properties

  Name Description
Public property BodyStyle Gets and sets the body style of the messages that are sent to and from an operation.
Public property IsBodyStyleSetExplicitly Gets the IsBodyStyleSetExplicitly property.
Public property IsRequestFormatSetExplicitly Gets the IsRequestFormatSetExplicitly property.
Public property IsResponseFormatSetExplicitly Gets the IsResponseFormatSetExplicitly property.
Public property RequestFormat Gets and sets the RequestFormat property.
Public property ResponseFormat Gets and sets the ResponseFormat property.
Public property UriTemplate Gets and sets the Uniform Resource Identifier (URI) template for the operation.

Top

Methods

  Name Description
Public method Equals Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Protected method 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.)
Public method GetHashCode Returns the hash code for this instance. (Inherited from Attribute.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method Match When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

The WebGetAttribute attribute is applied to an operation in addition to the OperationContractAttribute and associates the operation with a UriTemplate as well as the HTTP protocol Get verb. The association with HTTP Get verb means that the operation is used to retrieve information. The WebGetAttribute attribute is a passive operation behavior (the IOperationBehavior methods do nothing) that adds metadata to the operation description. Applying the WebGetAttribute attribute to an operation has no effect unless a behavior that is looking for this metadata in the operation description (such as WebHttpBehavior) is added to the behavior collection.

Operations with the WebGetAttribute attribute applied should be logical retrieval operations. The HTTP GET method is associated with all operations marked with the WebGetAttribute attribute.

Examples

The following example shows how to use the WebGetAttribute attribute.

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.