WebGetAttribute Klasse
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Stellt ein Attribut dar, dass angibt dass ein Dienstvorgang logisch als Abrufvorgang gilt und mit dem WCF-REST-Programmiermodell aufgerufen werden kann.
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- Vererbung
- Attribute
- Implementiert
Beispiele
Im folgenden Beispiel wird die Verwendung des WebGetAttribute-Attributs veranschaulicht.
[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
Hinweise
Das WebGetAttribute-Attribut wird zusätzlich zu OperationContractAttribute auf einen Dienstvorgang angewendet und ordnet den Vorgang einer UriTemplate sowie dem GET-Verb des HTTP-Protokolls zu. Die Zuordnung zu dem HTTP-GET-Verb bedeutet, dass der Vorgang zum Abrufen von Informationen vom Dienst verwendet wird. Das WebGetAttribute Attribut ist ein passives Vorgangsverhalten (die IOperationBehavior Methoden tun nichts), das Metadaten zur Vorgangsbeschreibung hinzufügt. Die Anwendung des WebGetAttribute-Attributs auf einen Dienstvorgang hat nur dann Auswirkungen, wenn ein Verhalten, das in der Vorgangsbeschreibung nach diesen Metadaten sucht (beispielsweise WebHttpBehavior), der Verhaltensauflistung des Diensts hinzugefügt wird.
Dienstvorgänge mit dem WebGetAttribute-Attribut müssen logische Abrufvorgänge sein. Die HTTP-GET-Methode wird allen mit dem WebGetAttribute-Attribut gekennzeichneten Vorgängen zugeordnet.
Konstruktoren
| WebGetAttribute() |
Initialisiert eine neue Instanz der WebGetAttribute-Klasse. |
Eigenschaften
| BodyStyle |
Ruft das Textformat der Nachrichten ab, die an den Dienstvorgang bzw. von dem Dienstvorgang gesendet werden, oder legt dieses fest. |
| IsBodyStyleSetExplicitly |
Ruft die IsBodyStyleSetExplicitly-Eigenschaft ab. |
| IsRequestFormatSetExplicitly |
Ruft die IsRequestFormatSetExplicitly-Eigenschaft ab. |
| IsResponseFormatSetExplicitly |
Ruft die IsResponseFormatSetExplicitly-Eigenschaft ab. |
| RequestFormat |
Ruft die RequestFormat-Eigenschaft ab oder legt diese fest. |
| ResponseFormat |
Ruft die ResponseFormat-Eigenschaft ab oder legt diese fest. |
| TypeId |
Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab. (Geerbt von Attribute) |
| UriTemplate |
Ruft die URI-Vorlage (Uniform Resource Identifier) für den Dienstvorgang ab oder legt diese fest. |
Methoden
| Equals(Object) |
Gibt einen Wert zurück, der angibt, ob diese Instanz gleich einem angegebenen Objekt ist. (Geerbt von Attribute) |
| GetHashCode() |
Gibt den Hashcode für diese Instanz zurück. (Geerbt von Attribute) |
| GetType() |
Ruft den Type der aktuellen Instanz ab. (Geerbt von Object) |
| IsDefaultAttribute() |
Gibt beim Überschreiben in einer abgeleiteten Klasse an, ob der Wert der Instanz der Standardwert für die abgeleitete Klasse ist. (Geerbt von Attribute) |
| Match(Object) |
Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht. (Geerbt von Attribute) |
| MemberwiseClone() |
Erstellt eine flache Kopie des aktuellen Object. (Geerbt von Object) |
| ToString() |
Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object) |