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

使用方法

現在のアプリケーションビューに関する情報を返します。このメソッドは API バージョン 38.0 以降で使用できます。

構文

1sforce.opencti.getAppViewInfo({
2     callback: function
3});

引数

名前	型	説明
callback	function	API メソッドコールが完了するときに実行された JavaScript メソッド。

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

1<html>
2  <head>
3    <script type="text/javascript" src="https://domain:port/support/api/55.0/lightning/opencti_min.js"></script>
4    <script type="text/javascript">
5      var callback = function(response) {
6         if (response.success) {
7            console.log('API method call executed successfully! returnValue:', response.returnValue);
8         } else { 
9            console.error('Something went wrong! Errors:', response.errors);
10         } 
11      };
12
13      function getAppViewInfo() {
14          sforce.opencti.getAppViewInfo({callback: callback});
15      }
16     </script>
17  </head>
18  <body>
19    <button onclick="getAppViewInfo();">getAppViewInfo()</button>
20  </body>
21</html>

応答

このメソッドは非同期です。応答は、コールバックメソッドに渡されたオブジェクトで返されます。応答オブジェクトには次の項目が含まれます。

レコード詳細ページからリストビューに切り替えるときに、このメソッドで返される内容は次のとおりです。

Lightning Experience では、url のみ
Lightning Experience コンソールアプリケーションでは、リスナーが呼び出されないため何も返されない

名前	型	説明
success	boolean	API メソッドコールが正常に呼び出された場合は `true`、それ以外の場合は `false` が返されます。
returnValue	object	現在のアプリケーションビューの URL を返し、該当するレコード ID、レコード名、およびオブジェクト種別が含まれます。次に例を示します。 `1{ 2 "url": "https://MyDomainNamemy.salesforce.com/lightning/r/Case/500D0000003tcchIAA/view?t=1459806689555", 3 "recordId": "001x0000003DGQR", 4 "recordName": "Acme", 5 "objectType": "Account" 6}` 個人取引先オブジェクトでこの API メソッドを呼び出すと、次の追加情報が返されます。 `accountId` または `contactId` — 関連する取引先または取引先責任者の ID。 `personAccount` — 組織で個人取引先が有効になっている場合は `true`、それ以外の場合は `false`。次に例を示します。 `1{ 2 "url": "https://MyDomainNamemy.salesforce.com/lightning/r/Account/001x0000003DGQR/view", 3 "recordId": "001x0000003DGQR", 4 "recordName": "Acme Person Account", 5 "objectType": "Account", 6 "contactId": "003D000000QOMqg", 7 "personAccount": true 8}` returnValue の URL 構造は今後変更される可能性があるため、この項目に基づくロジックは構築しないことをお勧めします。メモ
error	array	API コールが正常に行われた場合、この変数は `null` になります。API コールが失敗した場合、この変数はエラーメッセージの配列を返します。