汎用メッセージ画面¶
アプリケーション内で発生したエラーによっては、回復不能な場合があります。このような場合に表示する画面と、その画面に遷移するための API を提供します。
API¶
表示できるメッセージ表示画面の種類、その画面に遷移するための API を以下に示します。
- エラー
- Transfer.toErrorPage
- 警告
- Transfer.toWarningPage
- インフォメーション
- Transfer.toInformationPage
メッセージ表示画面に表示できるのは、
- タイトル
- メッセージ
- 詳細なエラーメッセージ
の３つです。また、メッセージ表示画面表示後の遷移先を指定することも可能です。遷移先 URL、遷移先 URL のラベルを指定すると、画面遷移のボタンが表示されます。遷移先 URL へ引き渡すパラメータを指定すると、そのパラメータが遷移先に引き渡されます。メッセージ表示画面へはリダイレクトを利用して遷移します。
実装例¶
エラー画面へ遷移するための例を示します。パラメータの詳細は、API リファレンスを参照してください。function error(request) { Transfer.toErrorPage({ title: 'タイトル', message: 'メッセージ', detail: ['詳細メッセージ1', '詳細メッセージ2'], returnUrl: '/login', // 戻り先 URL returnUrlLabel: 'ログイン画面へ戻る', parameter: { key: 'value', list: ['1','2','3'] } }); }
コラム
上記パラメータのメッセージは多言語対応していません。多言語対応したい場合は、MessageManager から取得したメッセージをセットしてください。
コラム
テーマを適用させたくない場合には、API を呼び出す前に request.setAttribute(‘imui-theme-builder-module’, ‘notheme’) を実行し、テーマを適用しないようにしてください。