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

refreshPrimaryTabById()

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

構文

1sforce.console.refreshPrimaryTabById(id:String, activate:Boolean, (optional)callback:Function, (optional)fullRefresh:Boolean)

引数

名前	型	説明
id	string	更新する主タブの ID。
activate	boolean	`true` の場合、更新された主タブがすぐに表示されます。`false` の場合、更新された主タブがバックグラウンドで表示されます。
callback	function	メソッドの完了時にコールされる JavaScript メソッド。
fullRefresh	boolean	ケースフィード全体のフル更新を有効にします。

サンプルコード – Visualforce

1<apex:page standardController="Case">
2
3     <A HREF="#" onClick="testRefreshPrimaryTabById();return false">
4         Click here to refresh a primary tab by id</A> 
5
6    <apex:includeScript value="/support/console/47.0/integration.js"/>
7    <script type="text/javascript">
8        function testRefreshPrimaryTabById() {
9            //Get the value for 'scc-pt-0' from the openPrimaryTab method
10            //This value is for example purposes only
11            var primaryTabId = 'scc-pt-0';
12            sforce.console.refreshPrimaryTabById(primaryTabId, true, refreshSuccess);
13        }
14        
15        var refreshSuccess = function refreshSuccess(result) {
16            //Report whether refreshing the primary tab was successful
17            if (result.success == true) {
18                alert('Primary tab refreshed successfully');
19            } else {
20                alert('Primary did not refresh');
21            }
22        };
23        
24  </script>
25
26</apex:page>

この例を実際に確認するには、ケースのカスタムリンクをクリックします。詳細は、Salesforce ヘルプの「カスタムボタンとカスタムリンクの定義」を参照してください。

メモ

応答

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

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

Salesforce コンソール開発者ガイド

refreshPrimaryTabById()

構文

引数

サンプルコード – Visualforce

応答