[kintone][カスタマイズjavascript]イベントのトリガーを定義する

eh657883

概要

カスタマイズjavascriptでは、デフォルトで画面を切り替えるたびに処理が実行されてしまう。

特定の画面で処理を実行するためにはその条件を記述する必要がある。

記述方法はkintone APIドキュメント > イベントに詳しく説明がある。

記述方法

kintone.events.onによりイベントタイプを登録する。
第1引数にイベントタイプを、第2引数に引数にeventを取る関数を指定する。

単一指定

(() => {
    'use strict';
    kintone.events.on('app.record.create.show', (event) => {
        alert('レコード登録画面が呼ばれました。');
        return event;
    });
})();

複数指定

複数指定の場合は、イベントタイプを配列形式で指定する

(() => {
   'use strict';
   kintone.events.on(['app.record.create.show', 'app.record.edit.show'], (event) => {
        alert('レコード登録画面または編集画面が呼ばれました。');
        return event;
    });
})();

事前にイベントタイプを変数・定数として定義してもよい。

(() => {
    'use strict';
    const events = ['app.record.create.show', 'app.record.edit.show'];
    // レコード登録画面の初期表示時
    kintone.events.on(events, (event) => {
        alert('レコード登録画面または編集画面が呼ばれました。');
        return event;
    });
})();ふぃ

イベントタイプ

イベントの一覧もkintone Javascript API に定義されているが、主要な項目のみ抜粋する。

対象画面 イベント発生タイミング 識別子
一覧画面 初期表示 app.record.index.show
詳細画面 初期表示 app.record.detail.show
作成画面 初期表示 app.record.create.show
フィールドの値が変更された app.record.create.change.フィールドコード
保存開始時 app.record.create.submit
保存完了時 app.record.create.submit.success
編集画面 初期表示 app.record.edit.show
フィールドの値が変更された app.record.edit.change.フィールドコード
保存開始時 app.record.edit.submit
保存完了時 app.record.edit.submit.success