コンソール API メソッドの等価性 — Lightning Experience と Salesforce Classic の違いは? | Salesforce コンソール開発者ガイド

次の表では、Salesforce コンソールインテグレーションツールキット (Salesforce Classic) のどのメソッドが Lightning コンソール JavaScript API (Lightning Experience) のメソッドおよびイベントに対応付けられているのかを示します。Salesforce コンソールインテグレーションツールキットのすべてのメソッドに Lightning の類似メソッドがあるわけではありません。一部の Classic メソッドは、Lightning イベントを使用したり、Lightning Experience メソッドを組み合わせたり、メソッドやイベントが含まれる反復ロジックおよび条件ロジックを使用したりして複製できます。

この表には、Lightning コンソール JavaScript API メソッドや回避策がある Salesforce コンソールインテグレーションツールキットメソッドのみが記載されています。代替メソッドや回避策のないメソッドはリストされていません。

重要

Lightning Experience では、Lightning Web コンポーネント (LWC) と Aura コンポーネントを使用してアプリケーションを作成できます。両方のコンポーネントが同じページ上で相互運用できます。ただし、LWC では現在、ワークスペースタブとサブタブの操作のみがサポートされています。

主タブとサブタブ用のメソッド

Salesforce コンソールインテグレーションツールキット (Salesforce Classic)	Lightning コンソール JavaScript API メソッド (Lightning Experience 用 Aura コンポーネント)	LWC のサポート
closeTab()	closeTab()	Aura コンポーネントと同じ。
focusPrimaryTabById()	focusTab()	Aura コンポーネントと同じ。
focusSubtabById()	focusTab()	Aura コンポーネントと同じ。
getEnclosingPrimaryTabId()	Lightning メソッド `getEnclosingTabId()` を使用します。コール元コンポーネントがサブタブ内にある場合、サブタブ ID が返されます。コール元コンポーネントがワークスペースタブ内にある場合、ワークスペース ID が返されます。	`EnclosingTabId` ワイヤーアダプターを使用します。
getEnclosingPrimaryTabObjectId()	`getEnclosingTabId()` を使用してタブ ID を取得します。次に、タブ ID を使用して、応答ペイロードにオブジェクト ID (該当する場合) が含まれる getTabInfo(tabId) をコールします。	`EnclosingTabId` ワイヤーアダプターを使用します。
getEnclosingTabId()	Lightning メソッド `getEnclosingTabId()` を使用します。コール元コンポーネントがサブタブ内にある場合、サブタブ ID が返されます。コール元コンポーネントがワークスペースタブ内にある場合、ワークスペース ID が返されます。	`EnclosingTabId` ワイヤーアダプターを使用します。
getFocusedPrimaryTabId()	getFocusedTabInfo()	Aura コンポーネントと同じ。
getFocusedPrimaryTabObjectId()	getFocusedTabInfo()	Aura コンポーネントと同じ。
getFocusedSubtabId()	getFocusedTabInfo()	Aura コンポーネントと同じ。
getPageInfo()	getTabInfo()	Aura コンポーネントと同じ。
getPrimaryTabIds()	サポートされていません。回避策: `getAllTabInfo()` をコールします。	Aura コンポーネントと同じ。
getSubtabIds()	サポートされていません。回避策: `getAllTabInfo()` をコールして、すべてのワークスペースタブオブジェクトのリストを取得します。ワークスペースタブオブジェクトを反復処理して、サブタブ ID (該当する場合) を収集します。	Aura コンポーネントと同じ。
getTabLink()	getTabURL()	getTabInfo() を使用します。
onEnclosingTabRefresh()	`getEnclosingTabId()` と共に lightning:tabRefreshed を使用します。	`lightning__tabRefreshed` Lightning メッセージチャネルを使用します。
onFocusedPrimaryTab()	lightning:tabFocused	`lightning__tabFocused` Lightning メッセージチャネルを使用します。
onFocusedSubtab()	lightning:tabFocused	`lightning__tabFocused` Lightning メッセージチャネルを使用します。
onTabSave()	サポートされていません。	サポートされていません。
openConsoleUrl()	openConsoleUrl()	サポートされていません。
openPrimaryTab()	openTab()	Aura コンポーネントと同じ。
openSubtab()	openSubtab()	Aura コンポーネントと同じ。
refreshPrimaryTabById()	refreshTab() を使用して、ワークスペースタブ ID を取得します。 Lightning API では `activate` 引数はサポートされていません。代わりに focusTab() と共に `refreshTab()` を使用します。	Aura コンポーネントと同じ。
refreshSubtabById()	refreshTab() を使用して、サブタブ ID を指定します。 Lightning API では `activate` 引数はサポートされていません。代わりに focusTab() と共に `refreshTab()` を使用します。	Aura コンポーネントと同じ。
setTabIcon()	setTabIcon()	Aura コンポーネントと同じ。
setTabTitle()	setTabLabel()	Aura コンポーネントと同じ。
setTabUnsavedChanges()	lightning:unsavedChanges コンポーネントを使用します。	サポートされていません。

ナビゲーションタブのメソッド

force:navigateToObjectHome Lightning イベントでは、Salesforce Classic の多くのナビゲーションタブメソッドのアクションを実行できます。

LWC では現在、ナビゲーションタブの操作はサポートされていません。

メモ

Salesforce コンソールインテグレーションツールキット (Salesforce Classic)	Lightning コンソール JavaScript API メソッド (Lightning Experience)
focusNavigationTab()	focusNavigationItem()
getNavigationTabs()	getNavigationItems()
getSelectedNavigationTab()	getSelectedNavigationItem()
refreshNavigationTab()	refreshNavigationItem()
setSelectedNavigationTab()	force:navigateToObjectHome

アプリケーションレベルのカスタムコンソールコンポーネント用のメソッド

LWC では現在、アプリケーションレベルのカスタムコンソールコンポーネントの操作はサポートされていません。

メモ

Salesforce コンソールインテグレーションツールキット (Salesforce Classic)	Lightning コンソール JavaScript API メソッド (Lightning Experience)
blinkCustomConsoleComponentButtonText()	サポートされていません。回避策: setUtilityLabel を使用します。
isCustomConsoleComponentWindowHidden()	getUtilityInfo()
onCustomConsoleComponentButtonClicked()	onUtilityClick()
setCustomConsoleComponentButtonIconUrl()	setUtilityIcon() setPanelHeaderIcon()
setCustomConsoleComponentButtonStyle()	setUtilityHighlighted
setCustomConsoleComponentButtonText()	setUtilityLabel
setCustomConsoleComponentHeight()	setPanelHeight()
setCustomConsoleComponentVisible()	openUtility() minimizeUtility()
setCustomConsoleComponentWidth()	setPanelWidth()

Live Agent のメソッド

LWC では現在、Live Agent の操作はサポートされていません。

メモ

Salesforce コンソールインテグレーションツールキット (Salesforce Classic)	Lightning コンソール JavaScript API メソッド (Lightning Experience)
endChat()	endChat()
getChatLog()	getChatLog()
sendCustomEvent()	sendCustomEvent()
sendMessage()	sendMessage()

オムニチャネルのメソッド

LWC では現在、オムニチャネルの操作はサポートされていません。

メモ

Salesforce コンソールインテグレーションツールキット (Salesforce Classic)	Lightning コンソール JavaScript API メソッド (Lightning Experience)
acceptAgentWork()	acceptAgentWork()
closeAgentWork()	closeAgentWork()
declineAgentWork()	declineAgentWork()
getAgentWorkload()	getAgentWorkload()
getAgentWorks()	getAgentWorks()
getServicePresenceStatusChannels()	getServicePresenceStatusChannels()
getServicePresenceStatusId()	getServicePresenceStatusId
login()	login()
logout()	logout()
sertServicePresenceStatus()	setServicePresenceStatus()

コンピューターテレフォニーインテグレーション (CTI) のメソッド

LWC では現在、CTI の操作はサポートされていません。

メモ

Salesforce コンソールインテグレーションツールキット (Salesforce Classic)	Lightning コンソール JavaScript API メソッド (Lightning Experience)
onCallBegin()	Aura と LWC のどちらでもサポートされていません。
onCallEnd()	Aura と LWC のどちらでもサポートされていません。
onCallLogSaved()	Aura と LWC のどちらでもサポートされていません。