elemento do método

Modelo de conteúdo

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

Atributos

  • @_operation (cadeia de caracteres)
  • @access (cadeia de caracteres)
  • @const (booleano)
  • @hidden (boolean)
  • @label (cadeia de caracteres)
  • @library (cadeia de caracteres)
  • @name (MNTOKEN)
  • @pkonly (booleano)
  • @static (booleano)

Pais

<methods> , <interface />

Filhos

  • <help>
  • <parameters>

Descrição

Esse elemento permite definir um método SOAP.

Uso e contexto de uso

Métodos SOAP habilitam processos de aplicativo.

A "@library" é necessária para declarar um novo método (não nativo): o namespace e o nome usado para a biblioteca são independentes do namespace e do nome do schema em que a declaração está.

Descrição do atributo

  • access (string): esse atributo define o controle de acesso para usar o método . Se este atributo estiver faltando, a identificação é obrigatória. Os valores disponíveis são: 'anonymous', 'admin' e 'sql'.
  • const (booleano): se estiver ativado, esse atributo significa que o método declarado alterará a entidade
  • label (string): rótulo do método.
  • biblioteca (string): esse método não é nativo do aplicativo. Esse atributo usa o valor da biblioteca de métodos, onde a definição do método é encontrada (nms:mylibrary.js).
  • nome (MNTOKEN): nome exclusivo do método.
  • estático (booleano): se este atributo estiver ativado, o método é considerado autônomo, todos os parâmetros devem ser especificados para o método quando for chamado.

Exemplos

Definição do método "Subscribe" pronto para uso:

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

Nesta página