m_form : client

  • Rversion finale: Yokohama
  • Mis à jour 30 janv. 2025
  • 3 minutes de lecture
  • Fournit des méthodes pour obtenir et définir des valeurs d’entrée sur les écrans du formulaire d’entrée, ainsi que pour afficher des messages.

    Cette API prend en charge les types d’entrée suivants :
    • Booléen
    • Choix
    • Date/Heure
    • Numéro
    • Référence
    • Chaîne

    Cette API peut être utilisée avec l’API pour remplir automatiquement les entrées sur les MobileScriptIncludeCaller : client écrans du formulaire d’entrée. Pour plus d’informations sur les écrans du formulaire d’entrée, reportez-vous à la section Input form screen.

    Utilisez cette API dans le champ Script client d’une action de règle d’interface utilisateur mobile. Pour obtenir des instructions sur la configuration d’une action de règle d’interface utilisateur mobile avec les paramètres corrects pour cette API, reportez-vous à la section Configure auto-fill inputs on input form screens.

    m_form : addErrorMessage(message de chaîne)

    Affiche un message d’erreur en haut de l’écran du formulaire d’entrée.

    Tableau 1. Paramètres
    Nom Type Description
    message Chaîne Message à afficher.
    Tableau 2. Renvoie
    Type Description
    Néant

    Dans cet exemple, un message d’information ou d’erreur s’affiche sur le formulaire en fonction de la valeur saisie pour la priorité.

    // 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(message de chaîne)

    Affiche un message d’information en haut de l’écran du formulaire d’entrée.

    Tableau 3. Paramètres
    Nom Type Description
    message Chaîne Message à afficher.
    Tableau 4. Renvoie
    Type Description
    Néant

    Dans cet exemple, un message d’information ou d’erreur s’affiche sur le formulaire en fonction de la valeur saisie pour la priorité.

    // 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(String inputName)

    Renvoie la valeur d’une entrée spécifiée sur un écran de formulaire d’entrée.

    Tableau 5. Paramètres
    Nom Type Description
    Nom d’entrée Chaîne Nom de l’entrée dont renvoyer la valeur.
    Tableau 6. Renvoie
    Type Description
    Chaîne Valeur de l’entrée spécifiée.
    Remarque :
    Si l’entrée est une liste de choix avec sélection multiple, le type de retour est un tableau de chaînes contenant les valeurs sélectionnées.

    Ce script client transmet la valeur d’entrée employee_id à l’include de script, qui utilise l’ID pour rechercher le titre de l’employé. Le titre est fourni à la fonction de rappel, qu’elle utilise pour remplir automatiquement l’entrée business_title sur l’écran du formulaire d’entrée.

    // 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); 
       }); 
    }

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

    Ajoute un effet de scintillement aux entrées spécifiées indiquant que la valeur est définie par un script.

    L’effet de scintillement prend fin une fois que la valeur de l’entrée est définie.

    Tableau 7. Paramètres
    Nom Type Description
    Noms d’entrée Tableau Tableau de chaînes contenant les noms des entrées auxquelles appliquer l’effet de scintillement.
    Tableau 8. Renvoie
    Type Description
    Néant

    Ce script client ajoute un effet de scintillement à l’entrée de l’appelant pour indiquer qu’elle est remplie automatiquement.

    // 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(String inputName, Object value, String displayValue)

    Définit la valeur d’une entrée spécifiée sur un écran de formulaire d’entrée.

    Tableau 9. Paramètres
    Nom Type Description
    Nom d’entrée Chaîne Nom de l’entrée dont définir la valeur.
    valide Objet Valeur sur laquelle définir l’entrée.

    Le type de données de la valeur varie en fonction de l’entrée définie.

    displayValue Chaîne Facultatif. Utilisez ce paramètre lors de la définition de la valeur des entrées de type Référence.
    Tableau 10. Renvoie
    Type Description
    Néant

    Cet exemple définit une valeur entière pour l’entrée de commande.

    m_form.setValue("order", 5);

    Cet exemple définit une valeur de chaîne pour l’entrée de description.

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

    Cet exemple utilise un objet contenant la valeur et la valeur d’affichage pour définir une entrée de type référence.

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