Salesforce Classic の refreshRelatedList() | Open CTI 開発者ガイド

使用方法

指定された listName を持つ関連リストが更新された場合は true、それ以外の場合は false を返します。このメソッドが Salesforce コンソール内でコールされると、現在フォーカスのあるビューで指定のリスト名を持つ関連リストのみが更新されます。このメソッドは、API バージョン 28.0 以降でのみ使用できます。

構文

1sforce.interaction.refreshRelatedList(listName:string, callback:function)

引数

名前	型	説明
listName	string	更新する関連リストの名前。たとえば、取引先責任者関連リストの取引先責任者や活動予定関連リストの活動。カスタム参照項目から作成されたカスタム関連リストを更新するには、listName は、カスタム参照項目の ID を指定する必要があります。
callback	function	API メソッドコールが完了するときに実行された JavaScript メソッド。

サンプルコード – JavaScript

1<html>
2<head>
3   <script type="text/javascript" src="http://domain:port/support/api/28.0/interaction.js"></script>
4   <script type="text/javascript">
5       function checkRefreshResult(result) {
6           if (result.result) {
7                  alert('The related list is refreshed!');
8            } else {
9                   alert('Cannot refresh the related list with the given listName! Make sure the listName is correct and the related list is on the page.');
10           }
11        }
12       function refreshActivityRelatedList() {
13                sforce.interaction.refreshRelatedList('Activity', checkRefreshResult);
14        }
15
16       function refreshHistoryRelatedList() {
17                sforce.interaction.refreshRelatedList('History', checkRefreshResult);
18        }
19
20       function saveAndRefresh() {
21                sforce.interaction.saveLog('Task', 'Subject=ImportantTask&WhatId=[15-character ID of an account to which you want to attach the task]', function(result) {
22           if (result.result) {
23                  refreshActivityRelatedList();
24            } else {
25                  alert('Could not save the object! Check the developer console for error messages.');
26            }
27      });
28}
29</script>
30</head>
31<body>
32       <button onclick="refreshHistoryRelatedList();">Refresh History Related List</button>
33       <button onclick="saveAndRefresh();">Save and Refresh</button>
34</body>
35</html>

応答

名前	型	説明
result	boolean	指定された名前を持つ関連リストが更新された場合は `true`、それ以外の場合は `false` を返します。
error	string	API コールが正常に行われた場合、この変数は未定義です。API コールが失敗した場合、この変数はエラーメッセージを返します。

メモ

このメソッドは、<apex:relatedList> から作成された関連リストを更新できません。
このメソッドは、Salesforce コンソールで上書きされた Visualforce ページから関連リストを更新できません。
Salesforce コンソール内からコールされると、このメソッドは現在フォーカスされているビューの更新対象の関連リストの検索のみを行います。