WebGetAttribute Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents an attribute indicating that a service operation is logically a retrieval operation and that it can be called by the WCF REST programming model.
public ref class WebGetAttribute sealed : Attribute, System::ServiceModel::Description::IOperationBehavior[System.AttributeUsage(System.AttributeTargets.Method)]
public sealed class WebGetAttribute : Attribute, System.ServiceModel.Description.IOperationBehavior[<System.AttributeUsage(System.AttributeTargets.Method)>]
type WebGetAttribute = class
inherit Attribute
interface IOperationBehaviorPublic NotInheritable Class WebGetAttribute
Inherits Attribute
Implements IOperationBehavior- Inheritance
- Attributes
- Implements
Examples
The following example shows how to use the WebGetAttribute attribute.
[ServiceContract]
public interface ICalculator
{
[OperationContract]
[WebGet]
long Add(long x, long y);
[OperationContract]
[WebGet(UriTemplate = "Sub?x={x}&y={y}")]
long Subtract(long x, long y);
[OperationContract]
[WebGet(UriTemplate = "Mult?x={x}&y={y}", BodyStyle = WebMessageBodyStyle.Bare)]
long Multiply(long x, long y);
[OperationContract]
[WebGet(UriTemplate = "Div?x={x}&y={y}", RequestFormat = WebMessageFormat.Xml)]
long Divide(long x, long y);
[OperationContract]
[WebGet(ResponseFormat= WebMessageFormat.Json)]
long Mod(long x, long y);
}
<ServiceContract()> _
Public Interface ICalculator
<OperationContract()> _
<WebGet()> _
Function Add(ByVal x As Long, ByVal y As Long) As Long
<OperationContract()> _
<WebGet(UriTemplate:="Sub?x={x}&y={y}")> _
Function Subtract(ByVal x As Long, ByVal y As Long) As Long
<OperationContract()> _
<WebGet(UriTemplate:="Mult?x={x}&y={y}", BodyStyle:=WebMessageBodyStyle.Bare)> _
Function Multiply(ByVal x As Long, ByVal y As Long) As Long
<OperationContract()> _
<WebGet(UriTemplate:="Div?x={x}&y={y}", RequestFormat:=WebMessageFormat.Xml)> _
Function Divide(ByVal x As Long, ByVal y As Long) As Long
<OperationContract()> _
<WebGet(ResponseFormat:=WebMessageFormat.Json)> _
Function Modulo(ByVal x As Long, ByVal y As Long) As Long
End Interface
Remarks
The WebGetAttribute attribute is applied to a service 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 from the service. 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 a service operation has no effect unless a behavior that is looking for this metadata in the operation description (such as WebHttpBehavior) is added to the service's behavior collection.
Service 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.
Constructors
| WebGetAttribute() |
Initializes a new instance of the WebGetAttribute class. |
Properties
| BodyStyle |
Gets or 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. |
| RequestFormat |
Gets or sets the RequestFormat property. |
| ResponseFormat |
Gets or sets the ResponseFormat property. |
| TypeId |
When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute) |
| UriTemplate |
Gets or sets the Uniform Resource Identifier (URI) template for the service operation. |
Methods
| Equals(Object) |
Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute) |
| GetHashCode() |
Returns the hash code for this instance. (Inherited from Attribute) |
| GetType() |
Gets the Type of the current instance. (Inherited from Object) |
| IsDefaultAttribute() |
When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute) |
| Match(Object) |
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) |
