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

使用方法

ビュー更新が呼び出された場合は true、それ以外の場合は false を返します。このメソッドが Salesforce コンソール内でコールされると、現在の有効なビューが更新されます。このタブに含まれている関連リストも更新されます。このメソッドは API バージョン 38.0 以降で使用できます。

構文

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

引数

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

サンプルコード – HTML とコールバックなしの JavaScript

1<html>
2<head>
3   <script type="text/javascript" src="http://domain:port/support/api/54.0/lightning/opencti_min.js"></script>
4   <script type="text/javascript">
5	var param = {};
6       	function refreshView() {
7                	sforce.opencti.refreshView(param);
8        	}
9</script>
10</head>
11<body>
12       <button onclick="refreshView();">refreshView</button>
13</body>
14</html>

サンプルコード – HTML とコールバック付きの JavaScript

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

応答

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

名前	型	説明
success	boolean	API メソッドコールの呼び出しが成功した場合は `true`、それ以外の場合は `false`。
returnValue	object	この API メソッドはこのオブジェクトを返しません。returnValue は常に `null` になります。
errors	array	API コールが正常に行われた場合、この変数は `null` になります。API コールが失敗した場合、この変数はエラーメッセージの配列を返します。