Lightning Experience の refreshTab()
tabId で指定されたワークスペースタブまたはサブタブを更新します。最初のサブタブの tabId は、ワークスペースタブと同じになります。このメソッドは、Lightning コンソールアプリケーションでのみ機能します。
保存されていない変更があるワークスペースタブでこのメソッドが呼び出されると、確認ウィンドウが開きます。
- 編集を継続: 変更が保持され、タブまたはワークスペースは更新されません。
- 変更を破棄: 変更が破棄され、タブまたはワークスペースが更新されます。
- 保存: 変更が保存され、タブまたはワークスペースが更新されます。
引数
| 名前 | 型 | 説明 |
|---|---|---|
| tabId | string | 更新するワークスペースタブまたはサブタブの ID。 |
| includeAllSubtabs | boolean | 省略可能。tabId がワークスペースタブに対応する場合、そのワークスペース内のすべてのサブタブが更新されます。デフォルトは true です。最初のサブタブの tabId は、ワークスペースタブと同じになります。 |
サンプルコード
このコンポーネントにはボタンがあり、押すと、フォーカスされているワークスペースタブと開いているそのすべてのサブタブが更新されます。
コンポーネントコード:
コントローラコード:
応答
このメソッドは、成功時に true に解決される Promise を返します。エラーが発生した場合、Promise は却下されます。