Lightning Experience の getAppViewInfo()
使用方法
現在のアプリケーションビューに関する情報を返します。このメソッドは API バージョン 38.0 以降で使用できます。
構文
引数
| 名前 | 型 | 説明 |
|---|---|---|
| callback | function | API メソッドコールが完了するときに実行された JavaScript メソッド。 |
サンプルコード – HTML および JavaScript
応答
このメソッドは非同期です。応答は、コールバックメソッドに渡されたオブジェクトで返されます。応答オブジェクトには次の項目が含まれます。
レコード詳細ページからリストビューに切り替えるときに、このメソッドで返される内容は次のとおりです。
- Lightning Experience では、url のみ
- Lightning Experience コンソールアプリケーションでは、リスナーが呼び出されないため何も返されない
| 名前 | 型 | 説明 |
|---|---|---|
| success | boolean | API メソッドコールが正常に呼び出された場合は true、それ以外の場合は false が返されます。 |
| returnValue | object | 現在のアプリケーションビューの URL を返し、該当するレコード ID、レコード名、およびオブジェクト種別が含まれます。次に例を示します。 個人取引先オブジェクトでこの API メソッドを呼び出すと、次の追加情報が返されます。
|
| error | array | API コールが正常に行われた場合、この変数は null になります。API コールが失敗した場合、この変数はエラーメッセージの配列を返します。 |