Salesforce Console Integration Toolkit Developer's Guide
jNewer Version Available
onEnclosingTabRefresh()
Registers a function to call
when the enclosing tab refreshes. This method is only available in API version 24.0 or
later.
Syntax
1sforce.console.onEnclosingTabRefresh(eventHandler:Function)Arguments
| Name | Type | Description |
|---|---|---|
| eventHandler | function | JavaScript method called when the enclosing tab refreshes. |
Sample Code–Visualforce
1swfobject.registerObject("clippy.codeblock-1", "9");
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17<apex:page>
18
19 <apex:includeScript value="/support/console/24.0/integration.js"/>
20
21 <script type="text/javascript">
22 var eventHandler = function eventHandler(result) {
23 alert('Enclosing tab has refreshed:' + result.id
24 + 'and the object Id is:' + result.objectId);
25 };
26 sforce.console.onEnclosingTabRefresh(eventHandler);
27 </script>
28</apex:page>Event Handler Response
This method is asynchronous so it returns its response in an object in a callback method. The response object contains the following fields:
| Name | Type | Description |
|---|---|---|
| id | string | The ID of the refreshed tab. |
| objectId | string | The object ID of the refreshed tab or null if no object exists. |