Salesforce コンソール開発者ガイド
jLightning コンソール API でサポートされている Classic コンソール API メソッド
一部の Salesforce コンソールインテグレーションツールキットメソッドを使用する Visualforce ページおよびサードパーティ Web タブは、Lightning Experience でそのまま機能します。Visualforce ページまたはサードパーティ Web タブのツールキットスクリプトの最新バージョンをポイントするだけです。サードパーティのコンテンツは、CSP ディレクティブを使用して、信頼済み URL を介して許可リストに登録する必要があります。次の表に、API バージョン 42.0 以降の Lightning コンソール JavaScript API で使用できる Salesforce コンソールインテグレーションツールキットメソッドを示します。
Lightning Experience でサポートされていない Salesforce コンソールインテグレーションツールキットメソッドの場合、エラーメッセージが表示されます。
主タブとサブタブ用のメソッド
| Salesforce Classic メソッド | Lightning コンソールでサポート (Aura) | Lightning コンソールでサポート (LWC) | Lightning コンソールでの使用に関する留意事項 |
|---|---|---|---|
| closeTab() |  |
|
|
| disableTabClose() | |
|
|
| focusPrimaryTabById() | |
|
|
| focusPrimaryTabByName() |  |
|
|
| focusSidebarComponent() | |
|
|
| focusSubtabById() | |
|
|
| focusSubtabByNameAndPrimaryTabId() | |
|
|
| focusSubtabByNameAndPrimaryTabName() | |
|
|
| generateConsoleUrl() | |
|
|
| getEnclosingPrimaryTabId() | |
|
|
| getEnclosingTabId() | |
|
|
| getFocusedPrimaryTabId() | |
|
|
| getFocusedPrimaryTabObjectId() | |
|
|
| getFocusedSubtabId() | |
|
|
| getFocusedSubtabObjectId() | |
|
|
| getPageInfo() | 注意を参照 | |
次の項目はサポートされておらず、応答で返されません。
|
| getPrimaryTabIds() | |
|
|
| getSubtabIds() | |
|
|
| getTabLink() | 注意を参照 | |
レベルの引数 sforce.console.TabLink.PARENT_AND_CHILDREN はサポートされていません。 |
| isInConsole() | |
|
|
| onEnclosingTabRefresh() | |
|
|
| onFocusedPrimaryTab() | |
|
|
| onFocusedSubtab() | |
|
Lightning API ではユーティリティ項目はサポートされていません。 |
| onTabSave() | |
|
|
| openConsoleUrl() | |
|
|
| openPrimaryTab() | 注意を参照 |
サードパーティドメインが信頼済み URL リストに追加されていることを確認します。 Lightning API では次の引数はサポートされていません。
|
|
| openSubtab() | 注意を参照 |
サードパーティドメインが信頼済み URL リストに追加されていることを確認します。 Lightning API では次の引数はサポートされていません。
|
|
| openSubtabByPrimaryTabName() | |
|
|
| refreshPrimaryTabById() | 注意を参照 | 注意を参照 | Lightning API では fullRefresh 引数はサポートされていません。 |
| refreshPrimaryTabByName() | |
|
|
| refreshSubtabById() | 注意を参照 | 注意を参照 | Lightning API では fullRefresh 引数はサポートされていません。 |
| refreshSubtabByNameAndPrimaryTabId() | |
|
|
| refreshSubtabByNameAndPrimaryTabName() | |
|
|
| reopenLastClosedTab() | |
|
|
| resetSessionTimeOut() | |
|
|
| setTabUnsavedChanges() | |
|
|
| setTabIcon() | 注意を参照 | 注意を参照 |
iconUrl では Salesforce Lightning Design System アイコンのみがサポートされています。URL およびカスタムアイコンはサポートされていません。 サポートされている値の例を次に示します。
|
| setTabLink() | |
|
|
| setTabStyle() | |
|
|
| setTabTextStyle() | |
|
|
| setTabTitle() | |
|
アプリケーションレベルのカスタムコンソールコンポーネント用のメソッド
次のメソッドは、Lightning ユーティリティ内からコールする必要があります。
| Salesforce Classic メソッド | Lightning コンソールでサポート | Lightning コンソールでの使用に関する留意事項 |
|---|---|---|
| addToBrowserTitleQueue() | |
|
| blinkCustomConsoleComponentButtonText() | |
|
| isCustomConsoleComponentPoppedOut() |
|
|
| isCustomConsoleComponentHidden() | |
|
| isInCustomConsoleComponent() | |
|
| onCustomConsoleComponentButtonClicked() | |
|
| removeFromBrowserTitleQueue() | |
|
| runSelectedMacro() | |
|
| scrollCustomConsoleComponentButtonText() | |
|
| selectMacro() | |
|
| setCustomConsoleComponentButtonIconUrl() | 注意を参照 | Lightning コンソールの場合、アイコンの URL 値はユーティリティバーのユーティリティではサポートされていません。Salesforce Lightning Design System のみがサポートされています。 サポートされている iconUrl 値の例を次に示します。
|
| setCustomConsoleComponentButtonStyle() | |
|
| setCustomConsoleComponentButtonText() | |
|
| setCustomConsoleComponentHeight() | |
|
| setCustomConsoleComponentVisible() | |
|
| setCustomConsoleComponentWidth() | |
|
| setCustomConsoleComponentPopoutable() | |
|
| setCustomConsoleComponentWindowVisible() | |
|
| setSidebarVisible() | |
ナビゲーションタブのメソッド
| Salesforce Classic メソッド | Lightning コンソールでサポート | Lightning コンソールでの使用に関する留意事項 |
|---|---|---|
| focusNavigationTab() | |
|
| getNavigationTabs() | |
|
| getSelectedNavigationTab() | |
|
| refreshNavigationTab() | |
|
| setSelectedNavigationTab() | |
Live Agent のメソッド
オムニチャネルのメソッド
| Salesforce Classic メソッド | Lightning コンソールでサポート | Lightning コンソールでの使用に関する留意事項 |
|---|---|---|
| acceptAgentWork() | |
|
| closeAgentWork() | |
|
| declineAgentWork() | |
|
| getAgentWorkload() | |
|
| getAgentWorks() | |
|
| getServicePresenceStatusChannels() | |
|
| getServicePresenceStatusId() | |
|
| login() | |
|
| logout() | |
|
| setServicePresenceStatus() | |
コンソールイベントのメソッド
| Salesforce Classic メソッド | Lightning コンソールでサポート | Lightning コンソールでの使用に関する留意事項 |
|---|---|---|
| addEventListener() | |
Lightning API では sforce.console.ConsoleEvent.CONSOLE_LOGOUT はサポートされていません。 sforce.console.ConsoleEvent.CLOSE_TAB は、閉じられたタブの ID のみを返します。Lightning API は、objectId または tabObjectId を返しません。 Lightning API は、カスタムキーボードショートカットからの特殊なメッセージ応答を返しません。ただし、応答がコンソールイベントからのものである場合、メッセージにはペイロードの詳細が含まれます。 |
| fireEvent() | 注意を参照 | fireEvent() は、指定された eventType の eventListeners が削除されている場合でも success true を返します。 |
| removeEventListener() | |