m_form - クライアント

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間:6分
  • 入力フォーム画面で入力値を取得および設定したり、メッセージを表示したりするメソッドを提供します。

    この API は、次の入力タイプをサポートしています。
    • ブーリアン
    • 選択肢
    • 日付/時刻
    • 番号
    • 参照
    • 文字列

    この API を MobileScriptIncludeCaller - クライアント API とともに使用して、入力フォーム画面に入力を自動入力できます。 入力フォーム画面の詳細については、 Input form screenを参照してください。

    この API は、モバイル UI ルールアクションの [クライアントスクリプト ] フィールドで使用します。この API の正しい設定でモバイル UI ルールアクションを構成する手順については、「 Configure auto-fill inputs on input form screens」を参照してください。

    m_form - addErrorMessage (文字列メッセージ)

    入力フォーム画面の上部にエラーメッセージを表示します。

    表 : 1. パラメーター
    名前 タイプ 説明
    message 文字列 表示するメッセージ。
    表 : 2. 返される内容
    タイプ 説明
    なし

    この例では、優先度に入力された値に応じて、フォームに情報メッセージまたはエラーメッセージが表示されます。

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

    入力フォーム画面の上部に情報メッセージを表示します。

    表 : 3. パラメーター
    名前 タイプ 説明
    message 文字列 表示するメッセージ。
    表 : 4. 返される内容
    タイプ 説明
    なし

    この例では、優先度に入力された値に応じて、フォームに情報メッセージまたはエラーメッセージが表示されます。

    // 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(文字列 inputName)

    入力フォーム画面で指定された入力の値を返します。

    表 : 5. パラメーター
    名前 タイプ Description (説明)
    inputName 文字列 値を返す入力の名前。
    表 : 6. 返される内容
    タイプ 説明
    文字列 指定された入力の値。
    注:
    入力が複数選択を含む選択リストの場合、戻り値の型は選択した値を含む文字列のアレイです。

    このクライアントスクリプトは、employee_id入力値をスクリプトインクルードに渡します。スクリプトインクルードは、ID を使用して従業員の役職を検索します。タイトルはコールバック関数に提供され、入力フォーム画面にbusiness_title入力を自動入力するために使用されます。

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

    スクリプトインクルード。

    // 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(配列 inputNames)

    値がスクリプトによって設定されていることを示すきらめく効果を指定された入力に追加します。

    きらめき効果は、入力の値が設定されると終了します。

    表 : 7. パラメーター
    名前 タイプ Description (説明)
    inputName アレイ きらめき効果を適用する入力の名前を含む文字列のアレイ。
    表 : 8. 返される内容
    タイプ 説明
    なし

    このクライアントスクリプトは、発信者入力にきらめき効果を追加して、自動入力されていることを示します。

    // 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(文字列 inputName, オブジェクト値, 文字列 displayValue)

    入力フォーム画面で指定された入力の値を設定します。

    表 : 9. パラメーター
    名前 タイプ Description (説明)
    inputName 文字列 値を設定する入力の名前。
    オブジェクト 入力を設定する値。

    値のデータタイプは、設定される入力によって異なります。

    displayValue 文字列 オプション。このパラメーターは、[参照タイプ入力] の値を設定するときに使用します。
    表 : 10. 返される内容
    タイプ 説明
    なし

    この例では、order 入力の整数値を設定します。

    m_form.setValue("order", 5);

    この例では、説明の入力に文字列値を設定します。

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

    この例では、値と表示値を含むオブジェクトを使用して、参照タイプの入力を設定します。

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