refreshSubtabByNameAndPrimaryTabId()
指定された名前と主タブ ID で最後に確認された URL を持つサブタブを更新します。最後に確認された URL が外部ページまたは Visualforce ページの場合、このメソッドではサブタブを更新できません。このメソッドは、API バージョン 22.0 以降でのみ使用できます。
構文
1sforce.console.refreshSubtabByNameAndPrimaryTabId(name:String, primaryTabId:String, active:Boolean, (optional)callback:Function)引数
| 名前 | 型 | 説明 |
|---|---|---|
| name | string | 更新するサブタブの名前。 |
| primaryTabId | string | サブタブが開いている主タブの ID。 |
| active | boolean | true の場合、更新されたサブタブがすぐに表示されます。false の場合、更新されたサブタブがバックグラウンドで表示されます。 |
| callback | function | メソッドの完了時にコールされる JavaScript メソッド。 |
サンプルコード – 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 standardController="Case">
18
19 <A HREF="#" onClick="testRefreshSubtabByNameAndPrimaryTabId();return false">
20 Click here to refresh a subtab by name and primary tab ID</A>
21
22 <apex:includeScript value="/support/console/22.0/integration.js"/>
23 <script type="text/javascript">
24 function testRefreshSubtabByNameAndPrimaryTabId() {
25 //Get the value for 'mySubtab' and 'scc-pt-0' from the openSubtab method
26 //These values are for example purposes only
27 var subtabName = 'mySubtab';
28 var primaryTabId = 'scc-pt-0';
29 sforce.console.refreshSubtabByNameAndPrimaryTabId(subtabName, primaryTabId, true, refreshSuccess);
30 }
31
32 var refreshSuccess = function refreshSuccess(result) {
33 //Report whether refreshing the subtab was successful
34 if (result.success == true) {
35 alert('Subtab refreshed successfully');
36 } else {
37 alert('Subtab did not refresh');
38 }
39 };
40
41 </script>
42
43</apex:page>応答
このメソッドは非同期であるため、コールバックメソッドのオブジェクトで応答を返します。応答オブジェクトには次の項目が含まれます。
| 名前 | 型 | 説明 |
|---|---|---|
| success | boolean | サブタブが正常に更新された場合は true、サブタブが更新されなかった場合は false。 |