イベントオブジェクトで実行できる操作

目次

kintoneのイベントオブジェクトで実行できる操作を説明します。

レコード一覧画面のイベント

表示するとき インライン編集を開始するとき フィールドの値を変更するとき 保存するとき 保存した後 削除するとき
フィールドの値を書き換える
フィールドの編集可/不可を設定する
フィールドにエラーを表示する
画面上部にエラーを表示する
指定したURLに遷移する
Promise対応

フィールドの値を書き換える

フィールドの値を書き換えるには、イベントハンドラー内でレコードのフィールドの値を変更し、イベントオブジェクトをreturnします。

  • フィールドの編集を不可に設定しても、値を書き換えることができます。
    フィールドの編集可/不可を設定する
  • 編集権限のないフィールドの値を書き換えた場合、フィールドの値を変更できません。
  • 同じイベントタイプの複数のハンドラーが登録されている場合、最後のハンドラーがreturnした値を基準に反映されます。
    最後に実行されるハンドラーがイベントオブジェクトをreturnしない場合、フィールドの値は反映されません。
非対応フィールド
  • レコード番号
  • 作成者
  • 作成日時
  • 更新者
  • 更新日時
  • ステータス
  • 作業者
  • 計算
  • 自動計算にした文字列1行
  • 添付ファイル
  • ルックアップ
  • ルックアップコピー先フィールド
サンプルコード

ドロップダウン(フィールドコード:ドロップダウン_0)のフィールドの値が変更されたとき、文字列1行(フィールドコード:文字列_0)の値を書き換える例です。

1
2
3
4
5
kintone.events.on('app.record.index.edit.change.ドロップダウン_0', (event) => {
  const record = event.record;
  record['文字列_0'].value = 'この文字列で上書き';
  return event;
});

ドロップダウン(フィールドコード:ドロップダウン_0)のフィールドの値が変更されたとき、テーブル(フィールドコード:テーブル_0)の1行目の文字列1行(フィールドコード:文字列_1)の値を書き換える例です。

1
2
3
4
5
kintone.events.on('app.record.index.edit.change.ドロップダウン_0', (event) => {
  const tableRow = event.record['テーブル_0'].value;
  tableRow[0].value['文字列_1'].value = 'テーブルの1行目を上書き';
  return event;
});

フィールドの編集可/不可を設定する

フィールドに編集可/不可を設定するには、イベントハンドラー内でフィールドのdisabledプロパティに真偽値を設定して、イベントオブジェクトをreturnします。

  • 編集可にするとき:「false」
  • 編集不可にするとき:「true」

編集権限のないフィールドのdisabledプロパティに「false」を設定しても、フィールドは編集可になりません。

非対応フィールド
  • レコード番号
  • 作成者
  • 作成日時
  • 更新者
  • 更新日時
  • ステータス
  • 作業者
  • 計算
  • 自動計算にした文字列1行
サンプルコード

ドロップダウン(フィールドコード:ドロップダウン_0)の値が変更されたとき、文字列1行(フィールドコード:文字列_0)を編集不可にする例です。

1
2
3
4
5
kintone.events.on('app.record.index.edit.change.ドロップダウン_0', (event) => {
  const record = event.record;
  record['文字列_0'].disabled = true;
  return event;
});

フィールドにエラーを表示する

フィールドにエラーメッセージを表示するには、イベントハンドラー内でフィールドのerrorプロパティに表示するメッセージを設定して、イベントオブジェクトをreturnします。

非対応フィールド
  • レコード番号
  • 作成者
  • 作成日時
  • 更新者
  • 更新日時
  • ステータス
  • 作業者
  • 計算
サンプルコード

ドロップダウン(フィールドコード:ドロップダウン_0)のフィールドの値が変更されたとき、文字列1行(フィールドコード:文字列_0)にエラーを表示する例です。

1
2
3
4
5
kintone.events.on('app.record.index.edit.change.ドロップダウン_0', (event) => {
  const record = event.record;
  record['文字列_0'].error = 'エラーです!';
  return event;
});

ドロップダウン(フィールドコード:ドロップダウン_0)のフィールドの値が変更されたとき、テーブル(フィールドコード:テーブル_0)の1行目の文字列1行(フィールドコード:文字列_1)にエラーを表示する例です。

1
2
3
4
5
kintone.events.on('app.record.index.edit.change.ドロップダウン_0', (event) => {
  const tableRow = event.record['テーブル_0'].value;
  tableRow[0].value['文字列_1'].error = 'エラーです!';
  return event;
});

画面上部にエラーを表示する

画面上部にエラーメッセージを表示するには、イベントハンドラー内でフィールドのerrorプロパティに表示するメッセージを設定して、イベントオブジェクトをreturnします。

サンプルコード

ドロップダウン(フィールドコード:ドロップダウン_0)のフィールドの値が変更されたとき、画面上部にエラーを表示する例です。

1
2
3
4
kintone.events.on('app.record.create.change.ドロップダウン_0', (event) => {
  event.error = 'エラーです!';
  return event;
});

指定したURLに遷移する

イベント処理後に指定したURLへ遷移するには、イベントハンドラー内でurlプロパティに遷移するURLを設定して、イベントオブジェクトをreturnします。

  • 「null」を設定すると、画面の遷移は発生しません。
サンプルコード

レコードの保存成功後に「https://cybozu.co.jp」へ遷移する例です。

1
2
3
4
kintone.events.on('app.record.index.edit.submit.success', (event) => {
  event.url = 'https://cybozu.co.jp';
  return event;
});

レコード詳細画面のイベント

表示するとき 削除するとき プロセス管理でアクションを実行するとき
フィールドの値を書き換える
画面上部にエラーを表示する
Promise対応

フィールドの値を書き換える

フィールドの値を書き換えるには、イベントハンドラー内でレコードのフィールドの値を変更し、イベントオブジェクトをreturnします。

  • 値を書き換えるには、レコードの編集権限が必要です。
  • ラジオボタンフィールドに空文字を指定した場合、ラジオボタンの初期値に設定されている選択肢が選ばれます。
  • 編集権限のないフィールドの値を書き換えた場合、フィールドの値を変更できません。
  • 同じイベントタイプの複数のハンドラーが登録されている場合、最後のハンドラーがreturnした値を基準に反映されます。
    最後に実行されるハンドラーがイベントオブジェクトをreturnしない場合、フィールドの値は反映されません。
非対応フィールド
  • レコード番号
  • 作成者
  • 作成日時
  • 更新者
  • 更新日時
  • ステータス
  • 作業者
  • 計算
  • 自動計算にした文字列1行
  • 添付ファイル
  • ルックアップ
  • ルックアップコピー先フィールド
サンプルコード

プロセスのアクションを実行して次のステータスに変わったとき、文字列1行(フィールドコード:文字列_0)の値を書き換える例です。

1
2
3
4
5
kintone.events.on('app.record.detail.process.proceed', (event) => {
  const record = event.record;
  record['文字列_0'].value = 'この文字列で上書き';
  return event;
});

プロセスのアクション実行後、次のステータスに変わったとき、テーブル(フィールドコード:テーブル_0)の1行目の文字列1行(フィールドコード:文字列_1)の値を書き換える例です。

1
2
3
4
5
6
kintone.events.on('app.record.detail.process.proceed', (event) => {
  const record = event.record;
  const tableRow = record['テーブル_0'].value;
  tableRow[0].value['文字列_1'].value = 'テーブルの1行目を上書き';
  return event;
});

画面上部にエラーを表示する

画面上部にエラーメッセージを表示するには、イベントハンドラー内でフィールドのerrorプロパティに表示するメッセージを設定して、イベントオブジェクトをreturnします。

サンプルコード

レコード詳細画面でレコードを削除するとき、レコードにエラーを表示する例です。

1
2
3
4
kintone.events.on('app.record.detail.delete.submit', (event) => {
  event.error = 'エラーです';
  return event;
});

レコード追加画面のイベント

表示するとき フィールドの値を変更するとき 保存するとき 保存した後
フィールドの値を書き換える
フィールドの編集可/不可を設定する
フィールドにエラーを表示する
画面上部にエラーを表示する
ルックアップを自動取得する
ルックアップのコピー先のフィールドの値を自動でクリアする
値を変更したフィールドやテーブル行のフィールドデータを取得する
指定したURLに遷移する
Promise対応

フィールドの値を書き換える

フィールドの値を書き換えるには、イベントハンドラー内でレコードのフィールドの値を変更し、イベントオブジェクトをreturnします。

  • フィールドの編集を不可に設定しても、フィールドの値を書き換えることができます。
    フィールドの編集可/不可を設定する
  • 編集権限のないフィールドの値を書き換えた場合、フィールドの値を変更できません。
  • 同じイベントタイプの複数のハンドラーが登録されている場合、最後のハンドラーがreturnした値を基準に反映されます。
    最後に実行されるハンドラーがイベントオブジェクトをreturnしない場合、フィールドの値は反映されません。
非対応フィールド
  • レコード番号
  • 作成者
  • 作成日時
  • 更新者
  • 更新日時
  • ステータス
  • 作業者
  • 計算
  • 自動計算にした文字列1行
  • 添付ファイル
  • ルックアップ
  • ルックアップコピー先フィールド
サンプルコード

文字列1行(フィールドコード:文字列_0)に初期値をセットする例です。

1
2
3
4
5
kintone.events.on('app.record.create.show', (event) => {
  const record = event.record;
  record['文字列_0'].value = 'この文字列で上書き';
  return event;
});

次のことを行う例です。

  • テーブル(フィールドコード:テーブル_0)の1行目の文字列1行(フィールドコード:文字列_1)に初期値を設定する。
  • テーブルの末尾に行を追加する。
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
kintone.events.on('app.record.create.show', (event) => {
  const record = event.record;
  const tableRow = record['テーブル_0'].value;
  tableRow[0].value['文字列_1'].value = 'テーブルの1行目を上書き';

  // テーブルの末尾に行を追加する
  const newRow = {
    value: {
      文字列_1: {
        type: 'SINGLE_LINE_TEXT', // テーブルの行を追加するには、フィールドタイプを指定する必要がある
        value: 'テーブルに追加する行',
      },
    },
  };
  tableRow.push(newRow);
  return event;
});

フィールドの編集可/不可を設定する

フィールドに編集可/不可を設定するには、イベントハンドラー内でフィールドのdisabledプロパティに真偽値を設定して、イベントオブジェクトをreturnします。

  • 編集可にするとき:「false」
  • 編集不可にするとき:「true」

編集権限のないフィールドのdisabledプロパティに「false」を設定しても、フィールドは編集可になりません。

非対応フィールド
  • レコード番号
  • 作成者
  • 作成日時
  • 更新者
  • 更新日時
  • ステータス
  • 作業者
  • 計算
  • 自動計算にした文字列1行
サンプルコード

ドロップダウン(フィールドコード:ドロップダウン_0)の値が変更されたとき、文字列1行(フィールドコード:文字列_0)を編集不可にする例です。

1
2
3
4
5
kintone.events.on('app.record.create.change.ドロップダウン_0', (event) => {
  const record = event.record;
  record['文字列_0'].disabled = true;
  return event;
});

フィールドにエラーを表示する

フィールドにエラーメッセージを表示するには、イベントハンドラー内でフィールドのerrorプロパティに表示するメッセージを設定して、イベントオブジェクトをreturnします。

非対応フィールド
  • レコード番号
  • 作成者
  • 作成日時
  • 更新者
  • 更新日時
  • ステータス
  • 作業者
  • 計算
サンプルコード

ドロップダウン(フィールドコード:ドロップダウン_0)のフィールドの値が変更されたとき、文字列1行(フィールドコード:文字列_0)にエラーを表示する例です。

1
2
3
4
5
kintone.events.on('app.record.create.change.ドロップダウン_0', (event) => {
  const record = event.record;
  record['文字列_0'].error = 'このエラーメッセージを表示';
  return event;
});

ドロップダウン(フィールドコード:ドロップダウン_0)のフィールドの値が変更されたとき、テーブル(フィールドコード:テーブル_0)の1行目の文字列1行(フィールドコード:文字列_1)にエラーを表示する例です。

1
2
3
4
5
6
kintone.events.on('app.record.create.change.ドロップダウン_0', (event) => {
  const record = event.record;
  const tableRow = record['テーブル_0'].value;
  tableRow[0].value['文字列_1'].error = 'テーブルの1行目にエラーを表示';
  return event;
});

画面上部にエラーを表示する

画面上部にエラーメッセージを表示するには、イベントハンドラー内でフィールドのerrorプロパティに表示するメッセージを設定して、イベントオブジェクトをreturnします。

サンプルコード

ドロップダウン(フィールドコード:ドロップダウン_0)のフィールドの値が変更されたとき、画面上部にエラーを表示する例です。

1
2
3
4
kintone.events.on('app.record.create.change.ドロップダウン_0', (event) => {
  event.error = 'エラーです!';
  return event;
});

ルックアップを自動取得する

ルックアップのコピー先の値を自動で設定するには、ルックアップフィールドのlookupプロパティに「UPDATE」または「true」を設定して、イベントオブジェクトをreturnします。

  • ルックアップの検索結果が1件の場合のみ、自動取得できます。
サンプルコード

レコード追加画面を開いたとき、ルックアップ(フィールドコード:ルックアップ_0)に値を設定してデータを取得する例です。

1
2
3
4
5
6
7
kintone.events.on('app.record.create.show', (event) => {
  const record = event.record;
  record['ルックアップ_0'].value = '0001';
  record['ルックアップ_0'].lookup = true;
  // またはrecord['ルックアップ'].lookup = 'UPDATE';
  return event;
});

ルックアップのコピー先のフィールドの値を自動でクリアする

ルックアップのコピー先の値を自動でクリアするには、ルックアップフィールドのlookupプロパティに「CLEAR」を設定して、イベントオブジェクトをreturnします。

サンプルコード

レコード追加画面を開いたとき、ルックアップ(フィールドコード:ルックアップ_0)のコピー先のフィールドの値を空にする例です。

1
2
3
4
5
kintone.events.on('app.record.create.show', (event) => {
  const record = event.record;
  record['ルックアップ_0'].lookup = 'CLEAR';
  return event;
});

値を変更したフィールドやテーブル行のフィールドデータを取得する

変更のあったフィールドやテーブル行のフィールドのデータを取得します。

  • rowプロパティは、テーブル内のイベント時のみ取得できます。
  • テーブル内の行を削除した際には、rowプロパティは「null」になります。
サンプルコード

レコード追加画面で、ドロップダウン(フィールドコード:ドロップダウン_0)の値が変更されたときの、変更のあったテーブルの行データを取得する例です。

1
2
3
4
5
kintone.events.on('app.record.create.change.ドロップダウン_0', (event) => {
  const row = event.changes.row;
  const field = event.changes.field;
  return event;
});

指定したURLに遷移する

イベント処理後に指定したURLへ遷移するには、イベントハンドラー内でurlプロパティに遷移するURLを設定して、イベントオブジェクトをreturnします。

  • 「null」を設定すると、画面の遷移は発生しません。
サンプルコード

レコードの保存成功後に「https://cybozu.co.jp」へ遷移する例です。

1
2
3
4
kintone.events.on('app.record.create.submit.success', (event) => {
  event.url = 'http://cybozu.co.jp/';
  return event;
});

レコード編集画面のイベント

表示するとき フィールドの値を変更するとき 保存するとき 保存した後
フィールドの値を書き換える ×
フィールドの編集可/不可を設定する × ×
フィールドにエラーを表示する ×
画面上部にエラーを表示する ×
ルックアップを自動取得する × ×
ルックアップのコピー先のフィールドの値を自動でクリアする × ×
値を変更したフィールドやテーブル行のフィールドデータを取得する × × ×
指定したURLに遷移する × × ×
Promise対応 ×

フィールドの値を書き換える

フィールドの値を書き換えるには、イベントハンドラー内でレコードのフィールドの値を変更し、イベントオブジェクトをreturnします。

  • フィールドの編集を不可に設定しても、フィールドの値を書き換えることができます。
    フィールドの編集可/不可を設定する
  • 編集権限のないフィールドの値を書き換えた場合、フィールドの値を変更できません。
  • 同じイベントタイプの複数のハンドラーが登録されている場合、最後のハンドラーがreturnした値を基準に反映されます。
    最後に実行されるハンドラーがイベントオブジェクトをreturnしない場合、フィールドの値は反映されません。
サンプルコード

レコード編集画面を開いたときに、次のフィールドに初期値を設定する例です。

  • 文字列1行(フィールドコード:文字列_0
  • テーブル(フィールドコード:テーブル_0)の1行目の文字列1行(フィールドコード:文字列_1
1
2
3
4
5
6
7
kintone.events.on('app.record.edit.show', (event) => {
  const record = event.record;
  record['文字列_0'].value = 'この文字列で上書き';
  const tableRow = record['テーブル_0'].value;
  tableRow[0].value['文字列_1'].value = 'テーブルの1行目を上書き';
  return event;
});
非対応フィールド

次のフィールドは、保存実行前イベントのハンドラーでフィールドの値を書き換えてreturnしても、フォームには反映されません。

  • レコード番号
  • 作成者
  • 作成日時
  • 更新者
  • 更新日時
  • ステータス
  • 作業者
  • 計算
  • 自動計算にした文字列1行
  • 添付ファイル
  • ルックアップ
  • ルックアップアップのコピー先のフィールド

フィールドの編集可/不可を設定する

フィールドに編集可/不可を設定するには、イベントハンドラー内でフィールドのdisabledプロパティに真偽値を設定して、イベントオブジェクトをreturnします。

  • 編集可にするとき:「false」
  • 編集不可にするとき:「true」

編集権限のないフィールドのdisabledプロパティに「false」を設定しても、フィールドは編集可になりません。

サンプルコード

ドロップダウン(フィールドコード:ドロップダウン_0)の値が変更になったとき、文字列1行(フィールドコード:文字列_0)を編集不可にする例です。

1
2
3
4
kintone.events.on('app.record.edit.change.ドロップダウン_0', (event) => {
  event.record['文字列_0'].disabled = true;
  return event;
});
編集可/不可にできないフィールド

次のフィールドの値を編集可/不可を設定してreturnしても、フォームには反映されません。

  • レコード番号
  • 作成者
  • 作成日時
  • 更新者
  • 更新日時
  • ステータス
  • 作業者
  • 計算
  • 自動計算にした文字列1行

フィールドにエラーを表示する

フィールドにエラーメッセージを表示するには、イベントハンドラー内でフィールドのerrorプロパティに表示するメッセージを設定して、イベントオブジェクトをreturnします。

サンプルコード

次のフィールドにエラーを表示する例です。

  • 文字列1行(フィールドコード:文字列_0
  • テーブル(フィールドコード:テーブル_0)の1行目の文字列1行(フィールドコード:文字列_1
1
2
3
4
5
6
7
kintone.events.on('app.record.edit.change.ドロップダウン_0', (event) => {
  const record = event.record;
  record['文字列_0'].error = 'このエラーメッセージを表示';
  const tableRow = record['テーブル_0'].value;
  tableRow[0].value['文字列_1'].error = 'テーブルの1行目にエラーを表示';
  return event;
});

次のフィールドは、エラーメッセージを設定しても、エラーは発生しません。

  • レコード番号
  • 作成者
  • 作成日時
  • 更新者
  • 更新日時
  • ステータス
  • 作業者
  • 計算

画面上部にエラーを表示する

画面上部にエラーメッセージを表示するには、イベントハンドラー内でフィールドのerrorプロパティに表示するメッセージを設定して、イベントオブジェクトをreturnします。

サンプルコード

ドロップダウン(フィールドコード:ドロップダウン_0)のフィールドの値が変更されたとき、画面上部にエラーを表示する例です。

1
2
3
4
kintone.events.on('app.record.edit.change.ドロップダウン_0', (event) => {
  event.error = 'エラーです!';
  return event;
});

ルックアップを自動取得する

ルックアップのコピー先の値を自動で設定するには、ルックアップフィールドのlookupプロパティに「UPDATE」または「true」を設定して、イベントオブジェクトをreturnします。

  • ルックアップの検索結果が1件の場合のみ、自動取得できます。
  • PCとモバイルで利用できます。
サンプルコード

レコード編集画面を開いたときに、ルックアップ(フィールドコード:ルックアップ_0)に値を設定してデータを取得する例です。

1
2
3
4
5
6
kintone.events.on('app.record.edit.show', (event) => {
  const record = event.record;
  record['ルックアップ_0'].value = '0001'; // ルックアップフィールドの値
  record['ルックアップ_0'].lookup = true; // またはrecord['ルックアップ_0'].lookup = 'UPDATE';
  return event;
});

ルックアップのコピー先のフィールドの値を自動でクリアする

ルックアップのコピー先の値を自動でクリアするには、ルックアップフィールドのlookupプロパティに「CLEAR」を設定して、イベントオブジェクトをreturnします。

  • PCとモバイルで利用できます。
サンプルコード

レコード編集画面を開いたときに、ルックアップ(フィールドコード:ルックアップ_0)のコピー先のフィールドの値を空にする例です。

1
2
3
4
5
kintone.events.on('app.record.edit.show', (event) => {
  const record = event.record;
  record['ルックアップ_0'].lookup = 'CLEAR';
  return event;
});

値を変更したフィールドやテーブル行のフィールドデータを取得する

変更のあったフィールドやテーブル行のフィールドのデータを取得します。

  • rowプロパティは、テーブル内のイベント時のみ取得できます。
  • テーブル内の行を削除した際には、rowプロパティは「null」になります。
サンプルコード

レコード編集画面で、ドロップダウン(フィールドコード:ドロップダウン_0)の値が変更されたときの、変更のあったテーブルの行データを取得する例です。

1
2
3
4
5
kintone.events.on('app.record.edit.change.ドロップダウン_0', (event) => {
  const row = event.changes.row;
  const field = event.changes.field;
  return event;
});

指定したURLに遷移する

イベント処理後に指定したURLへ遷移するには、イベントハンドラー内でurlプロパティに遷移するURLを設定して、イベントオブジェクトをreturnします。

  • 「null」を設定すると、画面の遷移は発生しません。
サンプルコード

レコードの保存成功後に「https://cybozu.co.jp」へ遷移する例です。

1
2
3
4
5
kintone.events.on('app.record.edit.submit.success', (event) => {
  event.url = 'https://cybozu.co.jp/';
  console.log('url: ' + event.url);
  return event;
});

イベント共通

Promise対応

WebブラウザーのPromiseをreturnすることで、非同期処理の完了を待ってからフィールドの値に応じた制御ができます。
同じkintoneのイベントに複数のイベントハンドラーが登録されているとき、エラーなどが発生してThenableオブジェクトが棄却された場合には、後続のイベントハンドラーの処理は実行されません。

記述方法は次のページを参考にしてください。
kintoneカスタマイズで非同期処理をしてみよう