Classic API と Lightning コンソール API の違いは?

コンソールインテグレーションツールキットと Lightning コンソール JavaScript API

Lightning コンソール JavaScript API および Salesforce コンソールインテグレーションツールキットはいずれも Classic または Lightning コンソールアプリケーションを操作できる JavaScript API です。ただし、各 API のメソッドの実装方法は異なります。

Lightning コンソール JavaScript API と Salesforce コンソールインテグレーションツールキットの違いを次に示します。

メソッドの使用場所が異なる

• Aura コンポーネントでは、Lightning コンポーネントの JavaScript コントローラで Lightning コンソール JavaScript API メソッドを使用します。
• Lightning Web コンポーネントでは、ワークスペース API メソッド、ワイヤアダプタ、および Lightning メッセージチャネルのみを使用できます。Lightning Web コンポーネントでは現在、ナビゲーション項目とユーティリティバーの操作はサポートされていません。
• Visualforce ページ、iframe ページ、サードパーティページは、Lightning Experience と Salesforce Classic の両方で機能します。Visualforce ページと iframe ページでは、Salesforce コンソールインテグレーションツールキットの Classic メソッドを使用します。ただし、使用できるメソッドに関する制限があります。サポートされているメソッドについての詳細は、「Lightning コンソール API でサポートされている Classic コンソール API メソッド」を参照してください。

  Salesforce Classic の Salesforce コンソールインテグレーションツールキットを使用する場合、Visualforce ページ、iframe ページ、サードパーティページの <script> タグ内でメソッドを使用します。

メソッドの入力構文が異なる

Lightning コンソール JavaScript API (Aura コンポーネント) のメソッドは JSON 配列の引数を取ります。

同様に、Lightning コンソール JavaScript API (LWC) のメソッドも JSON 配列の引数を取ります。

Aura コンポーネントの場合、必須パラメータはオブジェクトのメソッドに渡されます。LWC の場合、必須パラメータは明示的にメソッドに渡されます。

メモ

Salesforce コンソールインテグレーションツールキットのメソッドは、JSON 配列の引数を取りません。

API で提供されるメソッドが異なる

一部の Lightning Experience メソッドは Salesforce Classic メソッドと似ていますが、名前や提供される機能が異なります。

Lightning コンソール JavaScript API には、Lightning Experience でのみ使用できる、ユーティリティバーで使用するためのメソッドも用意されています。