Lightning Experience の onNavigationChange() | Open CTI 開発者ガイド

使用方法

ページの URL が変わったか、ユーザが現在の場所から離れて移動したらコールする関数を登録します。このメソッドは API バージョン 38.0 以降で使用できます。

構文

1sforce.opencti.onNavigationChange({
2     listener: function
3});

引数

名前	型	説明
listener	function	ナビゲーションの変更時にコールされる JavaScript メソッド。

サンプルコード – HTML および JavaScript

1<html>
2  <head>
3    <script type="text/javascript" src="https://domain:port/support/api/38.0/lightning/opencti_min.js"></script>
4    <script type="text/javascript">
5      var listener = function(payload) {
6        console.log('Navigation change occurred. Payload: ', payload);
7      };
8
9      // Register the listener.
10      window.addEventListener('load', function() {
11        sforce.opencti.onNavigationChange({listener: listener});
12      });
13   </script>
14  </head>
15</html>

ペイロード

リスナメソッドへの各コールに渡されるペイロードオブジェクトには次の項目が含まれます。

名前	型	説明
url	string	ユーザの移動先ページの URL を提供します。
recordId	string	ユーザが取引先やケースなどの Salesforce レコードに移動した場合、読み込まれたレコードの ID が返されます。それ以外の場合、項目は空白になります。
recordName	string	ユーザが Salesforce レコードに移動した場合、読み込まれたレコードの名前。それ以外の場合、項目は空白になります。
objectType	string	ユーザが Salesforce レコードに移動した場合、読み込まれたオブジェクトの種別 (取引先やケースなど)。それ以外の場合、項目は空白になります。
accountId または contactId	string	ユーザの移動先ページが個人取引先のレコードホームである場合、関連付けられた取引先または取引先責任者の ID が返されます。
personAccount	boolean	ユーザの移動先ページが個人取引先のレコードホームである場合、この項目は true です。組織で個人取引先が有効化されているが、ユーザの移動先ページが個人取引先のレコードホームではない場合、この項目は false です。個人取引先が組織で有効化されていない場合、この項目はペイロードオブジェクトに含まれません。