kintone API

確認ダイアログを表示する

目次

確認ダイアログを表示する

確認ダイアログを表示します。
ユーザーに確認を求めるダイアログを表示し、ユーザーの選択を取得できます。

このAPIは非同期なAPIです。
同期的に処理したい場合は、次のページを参照してください。

関数

PC

kintone.showConfirmDialog(config)

引数

パラメーター名 必須 説明
config オブジェクト 必須 ダイアログの設定
config.title 文字列 省略可 タイトル文字列
省略した場合は表示されません。
config.body 文字列 省略可 ダイアログ本文のテキスト
\n\r\r\nは、改行として解釈される
省略した場合は表示されません。
config.showOkButton 真偽値 省略可 OKボタンを表示するかどうか
  • true:表示する
  • false:表示しない
省略した場合は表示されます。
config.okButtonText 文字列 省略可 OKボタンに表示するテキスト
省略した場合はログインユーザーの言語にしたがって「OK」を意味するテキストが表示されます。
config.showCancelButton 真偽値 省略可 キャンセルボタンを表示するかどうか
  • true:表示する
  • false:表示しない
省略した場合は表示されません。
config.cancelButtonText 文字列 省略可 キャンセルボタンに表示するテキスト
省略した場合はログインユーザーの言語にしたがって「Cancel」を意味するテキストが表示されます。
config.showCloseButton 真偽値 省略可 閉じるボタンを表示するかどうか
  • true:表示する
  • false:表示しない
省略した場合は表示されません。
表示しない場合、Escキーでダイアログを閉じる機能も無効化されます。

戻り値

戻り値はPromiseオブジェクトです。
Promiseオブジェクトの解決時に次の値が取得できます。

戻り値 説明
result 文字列 ユーザーが選択した操作
  • OK:OKボタンをクリック
  • CANCEL:キャンセルボタンをクリック
  • CLOSE:閉じるボタンをクリック、またはEscキーを押下

サンプルコード

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
// 基本的な確認ダイアログ
kintone.showConfirmDialog({
  title: '確認',
  body: 'このレコードを削除しますか?',
  showOkButton: true,
  showCancelButton: true,
  okButtonText: '削除',
  cancelButtonText: 'キャンセル',
  showCloseButton: true
}).then((result) => {
  if (result === 'OK') {
    console.log('削除を実行します');
    // 削除処理
  } else {
    console.log('削除をキャンセルしました');
  }
});

利用できる画面

PC

利用できる画面は、全体カスタマイズの適用画面に従います。
kintone全体のカスタマイズが適用される画面

ただし、次の画面では利用できません。

  • 検索画面
  • アプリストア