ScriptMethodAttribute Clase
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Especifica qué verbo HTTP se utiliza para invocar un método y el formato de la respuesta. Esta clase no puede heredarse.
public ref class ScriptMethodAttribute sealed : Attribute[System.AttributeUsage(System.AttributeTargets.Method)]
public sealed class ScriptMethodAttribute : Attribute[<System.AttributeUsage(System.AttributeTargets.Method)>]
type ScriptMethodAttribute = class
inherit AttributePublic NotInheritable Class ScriptMethodAttribute
Inherits Attribute- Herencia
- Atributos
Ejemplos
En el ejemplo siguiente se muestra cómo aplicar ScriptMethodAttribute a los GetXmlDocument métodos y EchoStringAndDate para especificar qué verbo HTTP se va a usar y para especificar el formato de respuesta.
Comentarios
Este atributo se usa para especificar información para los métodos a los que se puede llamar desde el script de cliente. El atributo permite especificar qué verbo HTTP (GET o POST) se puede usar para invocar un método. También permite especificar si la respuesta tiene formato mediante notación de objetos JavaScript (JSON) o XML.
El atributo ScriptMethodAttribute es opcional. (Sin embargo, los métodos a los que se puede llamar desde el script de cliente deben tener aplicado el System.Web.Services.WebMethodAttribute atributo ). Si un método no está marcado con ScriptMethodAttribute, se llamará al método mediante el comando HTTP POST y la respuesta se serializará como JSON. No se puede invalidar esta configuración del script.
ScriptMethodAttribute solo toma parámetros con nombre. A continuación se muestran las propiedades de la ScriptMethodAttribute clase que se pueden usar como parámetros con nombre:
-
Especifica si el método se invocará mediante el comando HTTP GET. De manera predeterminada, es
false.Importante
Establecer la UseHttpGet propiedad
trueen podría suponer un riesgo de seguridad para la aplicación si está trabajando con datos confidenciales o transacciones. En las solicitudes GET, el explorador codifica el mensaje en la dirección URL y, por tanto, es un destino más sencillo para la manipulación. Para las solicitudes GET y POST, debe seguir las directrices de seguridad para proteger los datos confidenciales. -
Especifica si la respuesta se serializará como JSON o como XML. De manera predeterminada, es
Json. La ResponseFormat propiedad es útil para especificar XML como el tipo de valor devuelto cuando el método devuelve un XmlDocument objeto o XmlElement . -
Especifica si todos los tipos devueltos, incluidos los tipos de cadena, se serializan como XML. El valor de la XmlSerializeString propiedad se omite cuando la respuesta se serializa como JSON.
Para obtener más información sobre cómo usar atributos, vea Atributos.
Constructores
| ScriptMethodAttribute() |
Inicializa una nueva instancia de la clase ScriptMethodAttribute. |
Propiedades
| ResponseFormat |
Obtiene o establece el formato de la respuesta del método. |
| TypeId |
Cuando se implementa en una clase derivada, obtiene un identificador único para este Attribute. (Heredado de Attribute) |
| UseHttpGet |
Obtiene o establece un valor que indica si se va a invocar al método utilizando HTTP GET. |
| XmlSerializeString |
Obtiene o establece un valor que indica si todos los tipos de valor devueltos se serializan como XML, lo que incluye los tipos de cadena. |
Métodos
| Equals(Object) |
Devuelve un valor que indica si esta instancia es igual que un objeto especificado. (Heredado de Attribute) |
| GetHashCode() |
Devuelve el código hash de esta instancia. (Heredado de Attribute) |
| GetType() |
Obtiene el Type de la instancia actual. (Heredado de Object) |
| IsDefaultAttribute() |
Si se reemplaza en una clase derivada, indica si el valor de esta instancia es el valor predeterminado de la clase derivada. (Heredado de Attribute) |
| Match(Object) |
Cuando se invalida en una clase derivada, devuelve un valor que indica si esta instancia es igual a un objeto especificado. (Heredado de Attribute) |
| MemberwiseClone() |
Crea una copia superficial del Object actual. (Heredado de Object) |
| ToString() |
Devuelve una cadena que representa el objeto actual. (Heredado de Object) |
Implementaciones de interfaz explícitas
| _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) |
Asigna un conjunto de nombres a un conjunto correspondiente de identificadores de envío. (Heredado de Attribute) |
| _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) |
Obtiene la información de tipos de un objeto, que puede utilizarse para obtener la información de tipos de una interfaz. (Heredado de Attribute) |
| _Attribute.GetTypeInfoCount(UInt32) |
Recupera el número de interfaces de información de tipo que proporciona un objeto (0 ó 1). (Heredado de Attribute) |
| _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) |
Proporciona acceso a las propiedades y los métodos expuestos por un objeto. (Heredado de Attribute) |
