---
sourceDocument: Referência de API do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - pt-BR

ft:publication_title :

    - Referência de API do Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# m_form --- Cliente

# m_form --- Cliente {#ariaid-title1}

* Versão de lançamento: Xanadu
* 
* Atualizado 1 de ago. de 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 3 min. de leitura

Fornece métodos para obter e definir valores de entrada nas telas do formulário de entrada, bem como exibir mensagens.  
Esta API é compatível com os seguintes tipos de entrada:

* Booliano
* Escolha
* Date/hora
* Número
* Referência
* Cadeia de caracteres
{#m_formClientAPI__ul_hqy_jnl_ccc}

Esta API pode ser usada com a API [MobileScriptIncludeCaller - Cliente](https://servicenow-prod.fluidtopics.net/hbRcUpDBDBvLaoLY7NOjWg#MobileScriptInclCallerClientAPI "Fornece métodos para chamar inclusões de script de Ações de regra da IU para celular.") para preencher automaticamente as entradas nas telas do formulário de entrada. Para obter mais informações sobre as telas do formulário de entrada, consulte [Input form screen](https://www.servicenow.com/docs/access?context=parameter-input-screen&version=xanadu&pubname=xanadu-mobile&ft:locale=en-US).

Use esta API no campo Client script de uma Ação de regra da IU para celular. Para obter instruções sobre como configurar uma ação de regra da IU para celular com as configurações corretas para esta API, consulte [Configure auto-fill inputs on input form screens](https://www.servicenow.com/docs/access?context=config-autofil-inputs-nptfrmscrn&version=xanadu&pubname=xanadu-mobile&ft:locale=en-US).

## m_form -- addErrorMessage(cadeia de caracteres mensagem) {#ariaid-title2}

Exibe uma mensagem de erro na parte superior da tela do formulário de entrada.
{#mform-addErrorMessage_S__table_g3q_js2_mbc__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| message | Cadeia de caracteres | A mensagem a ser exibida. |
[Tabela 1. Parâmetros]

{#mform-addErrorMessage_S__table_g3q_js2_mbc} {#mform-addErrorMessage_S__table_h3q_js2_mbc__entry__2}

| Tipo | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 2. Retorna]

{#mform-addErrorMessage_S__table_h3q_js2_mbc}  
Neste exemplo, uma mensagem informativa ou de erro é exibida no formulário, dependendo do valor inserido para a prioridade.

    // Client script in a Mobile UI Rule Action
    function onChange(inputName, newValue) { 
       var priority = newValue; 
       if (priority > 0 && priority < 3) { 
          getMessage("This incident should be handled ASAP", function(response){ 
             m_form.addInfoMessage(response); 
          }); 
       } else { 
          getMessage("The selected priority is invalid", function(response){ 
             m_form.addErrorMessage(response); 
          }); 
       }	 
    }

## m_form -- addInfoMessage(cadeia de caracteres mensagem) {#ariaid-title3}

Exibe uma mensagem informativa na parte superior da tela do formulário de entrada.
{#mform-addInfoMessage_S__table_ofb_3s2_mbc__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| message | Cadeia de caracteres | A mensagem a ser exibida. |
[Tabela 3. Parâmetros]

{#mform-addInfoMessage_S__table_ofb_3s2_mbc} {#mform-addInfoMessage_S__table_pfb_3s2_mbc__entry__2}

| Tipo | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 4. Retorna]

{#mform-addInfoMessage_S__table_pfb_3s2_mbc}  
Neste exemplo, uma mensagem informativa ou de erro é exibida no formulário, dependendo do valor inserido para a prioridade.

    // Client script in a Mobile UI Rule Action
    function onChange(inputName, newValue) { 
       var priority = newValue; 
       if (priority > 0 && priority < 3) { 
          getMessage("This incident should be handled ASAP", function(response){ 
             m_form.addInfoMessage(response); 
          }); 
       } else { 
          getMessage("The selected priority is invalid", function(response){ 
             m_form.addErrorMessage(response); 
          }); 
       }	 
    }

## m_form -- getValue(cadeia de caracteres "inputName") {#ariaid-title4}

Retorna o valor de uma entrada especificada em uma tela de formulário de entrada.
{#mform-getValue_S__table_lpp_tr2_mbc__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| nomeDeEntrada | Cadeia de caracteres | Nome da entrada da qual o valor será retornado. |
[Tabela 5. Parâmetros]

{#mform-getValue_S__table_lpp_tr2_mbc} {#mform-getValue_S__table_mpp_tr2_mbc__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | O valor da entrada especificada. Nota: Se a entrada for uma lista de seleção com seleção múltipla, o tipo de retorno será uma matriz de cadeias de caracteres que contém os valores selecionados. |
[Tabela 6. Retorna]

{#mform-getValue_S__table_mpp_tr2_mbc}  
Este client script passa o valor de entrada employee_id para a inclusão de script, que usa o ID para pesquisar o cargo do funcionário. O título é fornecido para a função de retorno de chamada, que ele usa para preencher automaticamente a entrada business_title na tela do formulário de entrada.

    // Client script in a Mobile UI Rule Action
    function onChange(inputName, newValue) { 
       var employeeId = m_form.getValue("employee_id"); 
       var caller = new MobileScriptIncludeCaller("UserUtilsTest", "getBusinessTitle"); 
       caller.addParam("employeeId", employeeId); 
       caller.call(function(response) { 
          m_form.setValue("business_title", response); 
       }); 
    }

Inclusão de script.

    // Mobile callable script include
    var UserUtilsTest = Class.create(); 
    UserUtilsTest.prototype = Object.extendsObject(global.AbstractMobileCallableInclude, { 
       getBusinessTitle: function() { 
          var employeeId = this.getParameter("employeeId"); 
          var gr = new GlideRecord("sys_user"); 
          gr.get(employeeId); 
          return gr.getValue("title"); 
       }, 
       type: 'UserUtilsTest' 
    });

## m_form -- setAffectedInputs(Array inputNames) {#ariaid-title5}

Adiciona um efeito de brilho às entradas especificadas, indicando que o valor está sendo definido por um script.
O efeito de brilho termina quando o valor da entrada é definido.
{#mform-setAffectedInputs_O__table_d1p_ms2_mbc__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| inputNames | Matriz | Matriz de cadeias de caracteres que contém os nomes das entradas às quais o efeito de brilho será aplicado. |
[Tabela 7. Parâmetros]

{#mform-setAffectedInputs_O__table_d1p_ms2_mbc} {#mform-setAffectedInputs_O__table_e1p_ms2_mbc__entry__2}

| Tipo | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 8. Retorna]

{#mform-setAffectedInputs_O__table_e1p_ms2_mbc}  
Este client script adiciona um efeito de brilho à entrada do solicitante para indicar que ela é preenchida automaticamente.

    // Client script in a Mobile UI Rule Action
    function onChange(inputName, newValue) { 
       var affectedInputs = []; 
       affectedInputs.push("Caller"); 
       m_form.setAffectedInputs(affectedInputs); 
       m_form.setValue("Caller", ["800b174138d089c868d09de320f9833b", "46d44a23a9fe19810012d100cca80666"]); 
       var result = m_form.getValue("Caller"); 
       console.log(`Ref test: ${result[0]}`); 
    }

## m_form -- setValue(cadeia de caracteres "inputName", "objeto value", "string displayValue") {#ariaid-title6}

Define o valor de uma entrada especificada em uma tela de formulário de entrada.
{#mform-setValue_S_S_S__table_tp1_wr2_mbc__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| nomeDeEntrada | Cadeia de caracteres | Nome da entrada da qual o valor será definido. |
| valor | Objeto | Valor para definir a entrada. O tipo de dados do valor varia de acordo com a entrada que está sendo definida. |
| displayValue | Cadeia de caracteres | Opcional. Use este parâmetro ao definir o valor das entradas do tipo Referência. |
[Tabela 9. Parâmetros]

{#mform-setValue_S_S_S__table_tp1_wr2_mbc} {#mform-setValue_S_S_S__table_up1_wr2_mbc__entry__2}

| Tipo | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 10. Retorna]

{#mform-setValue_S_S_S__table_up1_wr2_mbc}  
Este exemplo define um valor inteiro para a entrada de pedido.

    m_form.setValue("order", 5);

Este exemplo define um valor de cadeia de caracteres para a entrada de descrição.

    m_form.setValue("description", "This is the description content");

Este exemplo usa um objeto que contém o valor e o valor de exibição para definir uma entrada de tipo de referência.

    m_form.setValue("Caller", [{"value":"800b174138d089c868d09de320f9833b", "displayValue":"Abel Tuter"}]);