kintone API

画面上部にメッセージを表示する

目次

画面上部にメッセージを表示する

画面上部にメッセージを表示します。
エラー、成功などの種類に応じて色分けされたメッセージを表示できます。

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

関数

PC

kintone.showNotification(type, message)

引数

パラメーター名 必須 説明
type 文字列 必須 NotificationUIのタイプ
次のいずれかの値を指定します。
  • ERROR:エラーを表す赤色のNotificationUI
  • SUCCESS:成功を表す緑色のNotificationUI
  • INFO:情報を表す青色のNotificationUI
message 文字列 必須 NotificationUIに表示するメッセージのテキスト

戻り値

戻り値はPromiseオブジェクトです。
Promiseオブジェクトの解決時に値は返りません。

サンプルコード

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
// エラーメッセージを表示
kintone.showNotification('ERROR', 'データの保存に失敗しました。');

// 成功メッセージを表示
kintone.showNotification('SUCCESS', 'データが正常に保存されました。');

// 情報メッセージを表示
kintone.showNotification('INFO', '処理を開始しました。');

// 非同期処理での使用例
kintone.showNotification('SUCCESS', '処理が完了しました。').then(() => {
  console.log('通知が表示されました');
});

利用できる画面

PC

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

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

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

注意事項

  • メッセージは画面上部に表示された後、自動的に消えません。
  • メッセージは、kintone本体のものも含め、同時に1つしか表示できず、一番最後に呼び出したものだけが表示されます。