WebInvokeAttribute WebInvokeAttribute WebInvokeAttribute WebInvokeAttribute Class

Определение

Представляет атрибут, указывающий, что операция службы логически является операцией вызова и может быть вызвана моделью программирования REST платформы WCF.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.

public ref class WebInvokeAttribute sealed : Attribute, System::ServiceModel::Description::IOperationBehavior
[System.AttributeUsage(System.AttributeTargets.Method)]
public sealed class WebInvokeAttribute : Attribute, System.ServiceModel.Description.IOperationBehavior
type WebInvokeAttribute = class
    inherit Attribute
    interface IOperationBehavior
Public NotInheritable Class WebInvokeAttribute
Inherits Attribute
Implements IOperationBehavior
Наследование
WebInvokeAttributeWebInvokeAttributeWebInvokeAttributeWebInvokeAttribute
Атрибуты
Реализации

Примеры

В следующем примере показано использование атрибута WebInvokeAttribute.The following example shows how to use the WebInvokeAttribute attribute.

Примечание

Поскольку свойство Method в следующем коде не задано, все операции службы сопоставляются с методом HTTP POST.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

Комментарии

Атрибут WebInvokeAttribute применяется к операции службы в дополнение к OperationContractAttribute и связывает операцию с UriTemplate так же, как и с основной командой транспорта, представляющей вызов (например, HTTP POST, PUT или DELETE).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). WebInvokeAttribute Атрибут пассивный поведение операции ( IOperationBehavior методы ничего не делать), добавляющее метаданные в описание операции.The WebInvokeAttribute attribute is a passive operation behavior (the IOperationBehavior methods do nothing) that adds metadata to the operation description. Применение атрибута WebInvokeAttribute к операции службы не имеет последствий, если в коллекцию поведения службы не добавлено поведение, обусловливающее поиск метаданных в описании операции (например, WebHttpBehavior).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. WebInvokeAttribute определяет, на какой метод HTTP реагирует операция службы.The WebInvokeAttribute determines what HTTP method that a service operation responds to. По умолчанию все методы, к которым применен атрибут WebInvokeAttribute, реагируют на запросы POST.By default, all methods that have the WebInvokeAttribute applied respond to POST requests. Свойство Method позволяет указать другой метод HTTP.The Method property allows you to specify a different HTTP method. Если необходимо, чтобы операция службы отвечала на метод GET, используйте атрибут WebGetAttribute.If you want a service operation to respond to GET, use the WebGetAttribute instead.

Конструкторы

WebInvokeAttribute() WebInvokeAttribute() WebInvokeAttribute() WebInvokeAttribute()

Инициализирует новый экземпляр класса WebInvokeAttribute.Initializes a new instance of the WebInvokeAttribute class.

Свойства

BodyStyle BodyStyle BodyStyle BodyStyle

Получает или задает стиль текста сообщений, отправляемых в операцию службы или из нее.Gets or sets the body style of the messages that are sent to and from the service operation.

IsBodyStyleSetExplicitly IsBodyStyleSetExplicitly IsBodyStyleSetExplicitly IsBodyStyleSetExplicitly

Возвращает свойство IsBodyStyleSetExplicitly.Gets the IsBodyStyleSetExplicitly property.

IsRequestFormatSetExplicitly IsRequestFormatSetExplicitly IsRequestFormatSetExplicitly IsRequestFormatSetExplicitly

Возвращает свойство IsRequestFormatSetExplicitly.Gets the IsRequestFormatSetExplicitly property.

IsResponseFormatSetExplicitly IsResponseFormatSetExplicitly IsResponseFormatSetExplicitly IsResponseFormatSetExplicitly

Возвращает свойство IsResponseFormatSetExplicitly.Gets the IsResponseFormatSetExplicitly property.

Method Method Method Method

Получает или задает метод протокола (например, HTTP), на который отвечает операция службы.Gets or sets the protocol (for example HTTP) method the service operation responds to.

RequestFormat RequestFormat RequestFormat RequestFormat

Возвращает или задает свойство RequestFormat.Gets or sets the RequestFormat property.

ResponseFormat ResponseFormat ResponseFormat ResponseFormat

Возвращает или задает свойство ResponseFormat.Gets or sets the ResponseFormat property.

TypeId TypeId TypeId TypeId

При реализации в производном классе возвращает уникальный идентификатор для этого Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)
UriTemplate UriTemplate UriTemplate UriTemplate

Шаблон универсального идентификатора ресурса (URI) для операции службы.The Uniform Resource Identifier (URI) template for the service operation.

Явные реализации интерфейса

IOperationBehavior.AddBindingParameters(OperationDescription, BindingParameterCollection) IOperationBehavior.AddBindingParameters(OperationDescription, BindingParameterCollection) IOperationBehavior.AddBindingParameters(OperationDescription, BindingParameterCollection) IOperationBehavior.AddBindingParameters(OperationDescription, BindingParameterCollection)

Реализует метод AddBindingParameters(OperationDescription, BindingParameterCollection).Implements the AddBindingParameters(OperationDescription, BindingParameterCollection) method.

IOperationBehavior.ApplyClientBehavior(OperationDescription, ClientOperation) IOperationBehavior.ApplyClientBehavior(OperationDescription, ClientOperation) IOperationBehavior.ApplyClientBehavior(OperationDescription, ClientOperation) IOperationBehavior.ApplyClientBehavior(OperationDescription, ClientOperation)

Реализует метод ApplyClientBehavior(OperationDescription, ClientOperation).Implements the ApplyClientBehavior(OperationDescription, ClientOperation) method.

IOperationBehavior.ApplyDispatchBehavior(OperationDescription, DispatchOperation) IOperationBehavior.ApplyDispatchBehavior(OperationDescription, DispatchOperation) IOperationBehavior.ApplyDispatchBehavior(OperationDescription, DispatchOperation) IOperationBehavior.ApplyDispatchBehavior(OperationDescription, DispatchOperation)

Реализует метод ApplyDispatchBehavior(OperationDescription, DispatchOperation).Implements the ApplyDispatchBehavior(OperationDescription, DispatchOperation) method.

IOperationBehavior.Validate(OperationDescription) IOperationBehavior.Validate(OperationDescription) IOperationBehavior.Validate(OperationDescription) IOperationBehavior.Validate(OperationDescription)

Реализует метод Validate(OperationDescription).Implements the Validate(OperationDescription) method.

IOperationContractAttributeProvider.GetOperationContractAttribute() IOperationContractAttributeProvider.GetOperationContractAttribute() IOperationContractAttributeProvider.GetOperationContractAttribute() IOperationContractAttributeProvider.GetOperationContractAttribute()
IWmiInstanceProvider.FillInstance(IWmiInstance) IWmiInstanceProvider.FillInstance(IWmiInstance) IWmiInstanceProvider.FillInstance(IWmiInstance) IWmiInstanceProvider.FillInstance(IWmiInstance)
IWmiInstanceProvider.GetInstanceType() IWmiInstanceProvider.GetInstanceType() IWmiInstanceProvider.GetInstanceType() IWmiInstanceProvider.GetInstanceType()
_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Сопоставляет набор имен соответствующему набору идентификаторов диспетчеризации.Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Возвращает сведения о типе объекта, которые могут использоваться для получения сведений о типе интерфейса.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32)

Возвращает количество предоставляемых объектом интерфейсов для доступа к сведениям о типе (0 или 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Предоставляет доступ к открытым свойствам и методам объекта.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Методы

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Возвращает значение, указывающее, равен ли этот экземпляр указанному объекту.Returns a value that indicates whether this instance is equal to a specified object.

(Inherited from Attribute)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Возвращает хэш-код для данного экземпляра.Returns the hash code for this instance.

(Inherited from Attribute)
GetType() GetType() GetType() GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute() 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) Match(Object) Match(Object) Match(Object)

При переопределении в производном классе возвращает значение, указывающее, является ли этот экземпляр равным заданному объекту.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Inherited from Object)

Применяется к