この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

refreshPrimaryTabByName()

サブタブを含む、名前で指定された主タブを更新します。このメソッドでは、外部ページまたは Visualforce ページへの URL を持つサブタブは更新できません。このメソッドは、API バージョン 22.0 以降でのみ使用できます。

構文

1sforce.console.refreshPrimaryTabByName(name:String, active:Boolean, (optional)callback:Function)

引数

名前	型	説明
name	string	更新する主タブの名前。
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="testRefreshPrimaryTabByName();return false">
20         Click here to refresh a primary tab by name</A>
21
22    <apex:includeScript value="/support/console/22.0/integration.js"/>
23    <script type="text/javascript">
24        function testRefreshPrimaryTabByName() {
25            //Set the name of the tab by using the openPrimaryTab method
26            //This value is for example purposes only
27            var primaryTabName = 'myPrimaryTab';
28            sforce.console.refreshPrimaryTabByName(primaryTabName, true, refreshSuccess);
29        }
30        
31        var refreshSuccess = function refreshSuccess(result) {
32            //Report whether refreshing the primary tab was successful
33            if (result.success == true) {
34                alert('Primary tab refreshed successfully');
35            } else {
36                alert('Primary tab did not refresh');
37            }
38        };
39        
40  </script>
41
42</apex:page>

この例は、ケース上のカスタムリンクをクリックすると実行されるように設定されています。詳細は、Salesforce オンラインヘルプの「カスタムボタンとリンクの定義」を参照してください。

メモ

応答

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

名前	型	説明
success	boolean	主タブが正常に更新された場合は `true`、主タブが更新されなかった場合は `false`。

Salesforce コンソールインテグレーションツールキット開発者ガイド

refreshPrimaryTabByName()

構文

引数

サンプルコード – Visualforce

応答