本日はkintoneカスタマイズをする上で必要なイベントハンドラーの登録、削除についてご紹介します。

kintone上で任意の処理を実行するには、kintoneで発生するイベントとイベントハンドラーを紐付ける必要があります。

■イベントとは

　kintoneで発生するイベントとは何かのアクションのことです。

　‘app.record.index.show’ →レコード一覧画面を表示した後

　app.record.create.show→新規レコード作成画面を表示した後

■イベントハンドラーとは

　イベントが発生した後に実行されたい処理内容が書かれている関数のこと

■イベントハンドラーの登録

　イベントハンドラーを登録するには、kintone JavaScript APIのkintone.events.onメソッドを使用する

kintone.events.on(type,handler)

kintone.events.on(イベントタイプ,実行されるイベントハンドラー)

     このメソッドに2つの引数を指定し、任意の処理内容を実行します。

　 例：レコード一覧の詳細画面が表示した後、イベント情報をコンソールに出力するイベントハンドラーを設定する

　 kintone.event.on(‘app.record.index.show’, (event) => {

     console.log(event);

■イベントハンドラーの削除

　イベントハンドラーを削除したい場合は、kintone.events.off()メソッドを使用する

　kintone.events.off(type,handler)

type=イベントハンドラーに紐付けるイベントのタイプを指定

　handler=イベント発生後に実行されるイベントハンドラーを指定

※このメソッドの引数は省略可能で、どの引数を省略するかによって実行される内容が変わります。

引数を省略しない場合、

kintone.events.off('app.record.index.show',handler);

指定されたイベントタイプから紐付けられるイベントハンドラーを削除

第２引数のイベントハンドラーを省略した場合、

kintone.events.off('app.record.index.show');

指定されたイベントタイプのすべてのイベントハンドラーを削除

両方省略した場合、

kintone.events.off();

すべてのイベントタイプからのすべてのイベントハンドラーを削除