method element

Inhaltsmodell

Methode:==( help | Parameter)

Attribute

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

Eltern

<methods> , <interface />

Kinder

• <help>
• <parameters>

Beschreibung

Mit diesem Element können Sie eine SOAP-Methode definieren.

Verwendung und Kontext der Verwendung von

SOAP-Methoden ermöglichen Anwendungsprozesse.

Die "@library"ist erforderlich, um eine neue Methode zu deklarieren (nicht native): der Namensraum und der Bibliotheksname sind unabhängig vom Namensraum und vom Namen des Schemas, in dem die Deklaration enthalten ist.

Attributbeschreibung

• access (Zeichenfolge): Dieses Attribut definiert die Zugriffskontrolle für die Verwendung der Methode. Wenn dieses Attribut fehlt, ist die Identifizierung obligatorisch. Verfügbare Werte sind: 'anonymous', 'admin' und 'sql'.
• const (boolean): Wenn es aktiviert ist, bedeutet dieses Attribut, dass die deklarierte Methode die Entität ändert
• label (Zeichenfolge): Bezeichnung der Methode.
• library (string): Diese Methode ist nicht nativ für die Anwendung. Dieses Attribut nimmt den Wert der Methodenbibliothek ein, in der die Methodendefinition gefunden wird (nms:mylibrary.js).
• name (MNTOKEN): eindeutiger Methodenname.
• statisch (boolean): Wenn dieses Attribut aktiviert ist, wird die Methode als autonom betrachtet, müssen alle Parameter bei Aufruf der Methode angegeben werden.

Beispiele

Definition der Out-of-the-Box-Methode "Abonnieren":

 
<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>