elemento de método

Modelo de contenido

método:==( help | parámetros)

Atributos

  • @_operation (cadena)
  • @access (cadena)
  • @const (booleano)
  • @hidden (booleano)
  • @label (cadena)
  • @library (cadena)
  • @name (MNTOKEN)
  • @pkonly (booleano)
  • @static (booleano)

Principales

<methods> , <interface />

Niños

  • <help>
  • <parameters>

Descripción

Este elemento permite definir un método SOAP.

Uso y contexto de uso

Los métodos SOAP permiten procesos de aplicación.

La "@library" es necesaria para declarar un nuevo método (no nativo): el espacio de nombres y el nombre utilizado para la biblioteca son independientes del espacio de nombres y el nombre del esquema donde está la declaración.

Descripción del atributo

  • access (cadena): este atributo define el control de acceso para el uso del método . Si falta este atributo, la identificación es obligatoria. Los valores disponibles son: 'anonymous', 'admin' y 'sql'.
  • const (booleano): si está activado, este atributo significa que el método declarado alterará la entidad
  • label (cadena): etiqueta del método .
  • library (string): este método no es nativo de la aplicación. Este atributo toma el valor de la biblioteca de métodos donde se encuentra la definición del método (nms:mylibrary.js).
  • name (MNTOKEN): nombre de método único.
  • static (booleano): si este atributo está activado, el método se considera autónomo, se deben especificar todos los parámetros del método cuando se llame a él.

Ejemplos

Definición del método "Suscribirse" fuera de la caja:

 
<method name="Subscribe" static="true">
      <help>Creation of update of a recipient's subscription to an information service</help>
      <parameters>
        <param desc="Name of the information service(s) (separated with commas)"
               name="serviceName" type="string"/>
        <param desc="Recipient to subscribe and possibly create" name="recipient"
               type="DOMElement"/>
        <param desc="Create the recipient if they don't exist" name="create" type="boolean"/>
      </parameters>     
    </method>

En esta página