メインコンテンツまでスキップ

レコード削除ボタンクリック時

app.record.detail.delete.submit イベントは、レコード詳細画面で削除ボタンクリック後の削除確認ダイアログの「OK」ボタンをクリックした際に発火します。
このイベントを利用することで、削除前の確認処理や、削除前に必要なチェック、カスタム処理を挟むことが可能です。

備考

このイベントはレコード詳細画面からの削除の場合に発火されます。
レコード一覧から削除やWebAPIによる削除の際は発火されませんので注意が必要です。

定義​

  • ユーザーが削除確認ダイアログの「OK」ボタンのクリック直後、実際の削除処理が始まる前に発火されます。
  • false を返却することで削除処理のキャンセルが出来ます。
atPocket.events.on('app.record.detail.delete.submit', handler)

関数パラメータ​

パラメータ名必須型説明文
type必須string | arrayイベントの名前。
複数のイベントで同じ処理を行いたい場合は配列形式で指定します。
handler必須functionhandler(event) => void
イベントが発生したときに呼び出されるコールバック関数を指定します。
引数 event の内容は下記参照。

イベントオブジェクトのプロパティ​

handlerの引数eventの内容
{
    "appId": "integer",
    "recordId": "integer",
    "record": "object",
}

戻り値​

  • false を返却すると削除処理をキャンセルできます

記述方法​

atPocket.events.on('app.record.detail.delete.submit', function(event) {
    // レコード新規登録画面の登録ボタンクリック時に実行する処理を記述
});

サンプルコード​

  • 有/無フィールドの値を確認して、チェックされている場合削除できないように制御します。
atPocket.events.on('app.record.detail.delete.submit', (event) => {
    // 削除ボタンが押されたが、削除処理実行前のタイミングでの処理を記述します。
    console.log('削除確認画面で「OK」がクリックされました');

    // 削除禁止(有/無フィールド)の値が「有」ならfalseを返却して削除処理をキャンセル
    if (event.record['field-3'].value === 1) {
        alert('削除禁止が選択されているため削除できません。');
        return false;
    }
});