elemento method method--element

Modello di contenuto content-model-10

metodo:==( guida | )

Attributi attributes-10

  • @_operation (stringa)
  • @access (stringa)
  • @const (boolean)
  • @hidden (boolean)
  • @label (stringa)
  • @library (stringa)
  • @name (MNTOKEN)
  • @pkonly (boolean)
  • @static (boolean)

Padri parents-10

<methods> , <interface />

Elementi figli children-10

  • <help>
  • <parameters>

Descrizione description-10

Questo elemento consente di definire un metodo SOAP.

Uso e contesto di utilizzo use-and-context-of-use-7

I metodi SOAP abilitano i processi dell'applicazione.

Il "@library" è necessario per dichiarare un nuovo metodo (non nativo): lo spazio dei nomi e il nome utilizzato per la libreria sono indipendenti dallo spazio dei nomi e dal nome dello schema in cui si trova la dichiarazione.

Descrizione attributo attribute-description-10

  • access (stringa): questo attributo definisce il controllo di accesso per l’utilizzo del metodo. Se questo attributo è mancante, l'identificazione è obbligatoria. I valori disponibili sono: "anonymous", "admin" e "sql".
  • const (booleano): se è attivato, significa che il metodo dichiarato modificherà l’entità
  • etichetta (stringa): etichetta del metodo.
  • libreria (stringa): metodo non nativo per l’applicazione. Questo attributo accetta il valore della libreria di metodi in cui viene trovata la definizione del metodo (nms:mylibrary.js).
  • nome (MNTOKEN): nome univoco del metodo.
  • statico (booleano): se questo attributo è attivato, il metodo viene considerato autonomo; quando viene richiamato, tutti i parametri devono essere specificati per il metodo.

Esempi examples-7

Definizione del metodo predefinito "Subscribe":


<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>
recommendation-more-help
601d79c3-e613-4db3-889a-ae959cd9e3e1