refreshView() for Lightning Experience

Usage

Returns true if view refresh is invoked, false otherwise. When this method is called within the Salesforce console, it refreshes the current active view. If any related lists are included in this tab, they’re refreshed too. This method is available in API version 38.0 or later.

Syntax

sforce.opencti.refreshView({
     callback:FUNCTION
});

Arguments

Sample Code–HTML and JavaScript without a callback

<html>
<head>
   <script type="text/javascript" src="http://domain:port/support/api//lightning/opencti_min.js"></script>
   <script type="text/javascript">
	var param = {};
       	function refreshView() {
                	sforce.opencti.refreshView(param);
        	}
</script>
</head>
<body>
       <button onclick="refreshView();">refreshView</button>
</body>
</html>

Sample Code–HTML and JavaScript with a callback

<html>
<head>
   <script type="text/javascript" src="http://domain:port/support/api//lightning/opencti_min.js"></script>
   <script type="text/javascript">
	var param = {};
            	var callback = function(response) {
         if (response.success) {
            console.log('API method call executed successfully! returnValue:', response.returnValue);
         } else { 
            console.error('Something went wrong! Errors:', response.errors);
         }
      	};
            param.callback = callback;
       
       function refreshView() {
                sforce.opencti.refreshView(param);
        }
</script>
</head>
<body>
       <button onclick="refreshView();">refreshView</button>
</body>
</html>

Response

This method is asynchronous. The response is returned in an object passed to a callback method. The response object contains the following fields.