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

openPrimaryTab()

指定された URL (相対または絶対) のコンテンツを表示する新しい主タブを開きます。また、既存のタブを上書きすることもできます。このメソッドは、API バージョン 20.0 以降でのみ使用できます。

ID が既存の主タブに対応している場合、Salesforce コンソールではタブの重複が無効であるため、既存のタブは指定された URL にリダイレクトされます。
URL が Salesforce オブジェクトを対象としている場合、そのオブジェクトは、Salesforce コンソールアプリケーション設定で指定したように表示されます。たとえば、ケースが親取引先のサブタブとして開くように設定されている場合、ケースで openPrimaryTab() がコールされると、ケースは親取引先の主タブのサブタブとして開きます。

タブを開くときにエラーが発生した場合、JavaScript コンソールでエラーコードがレポートされます。

構文

1sforce.console.openPrimaryTab(id:String, url:URL, active:Boolean, (optional)tabLabel:String, (optional)callback:Function, (optional)name)

引数

名前	型	説明
id	string	上書きする主タブの ID。新しい主タブを作成するには、`null` を使用します。 ID が既存の主タブに対応している場合、Salesforce コンソールではタブの重複が無効であるため、既存のタブは指定された URL にリダイレクトされます。
url	URL	開いている主タブの URL。 URL が Salesforce オブジェクトを対象としている場合、そのオブジェクトは、Salesforce コンソールアプリケーション設定で指定したように表示されます。たとえば、ケースが親取引先のサブタブとして開くように設定されている場合、ケースで `openPrimaryTab()` がコールされると、ケースは親取引先の主タブのサブタブとして開きます。ユーザは、コンソールのホワイトリストに追加されている外部 URL を開くことができます。詳細は、オ��ラインヘルプの「Salesforce Classic の Salesforce コンソールのホワイトリストのドメイン」を参照してください。相対 URL を使用する場合は、URL の先頭に必ず「`/`」を含めてください。Visualforce ページを参照する場合は、URL の先頭で「`/apex/`」を使用してください。このように指定しない場合、URL が期待どおりに動作しない場合があります。メモ
active	boolean	`true` の場合、開いている主タブがすぐに表示されます。`false` の場合、開いている主タブが背景で開き、フォーカスは現在のタブに残ります。
tabLabel	string	開いている主タブの表示ラベル (省略可能)。表示ラベルが指定されていないと、`外部ページ`が表示されます。表示ラベルをテキストとして追加します。HTML はサポートされていません。
callback	function	メソッドの完了時にコールされる JavaScript メソッド。
name	string	開いている主タブの名前 (省略可能)。この引数は、API バージョン 22.0 以降でのみ使用できます。

サンプルコード – Visualforce

1<apex:page standardController="Case">
2
3     <A HREF="#" onClick="testOpenPrimaryTab();return false">
4         Click here to open a new primary tab</A> 
5
6    <apex:includeScript value="/support/console/47.0/integration.js"/>
7    <script type="text/javascript">
8        function testOpenPrimaryTab() {
9            //Open a new primary tab with the salesforce.com home page in it
10            sforce.console.openPrimaryTab(null, 'http://www.salesforce.com', false, 
11                'salesforce', openSuccess, 'salesforceTab');
12        }
13        
14        var openSuccess = function openSuccess(result) {
15            //Report whether opening the new tab was successful
16            if (result.success == true) {
17                alert('Primary tab successfully opened');
18            } else {
19                alert('Primary tab cannot be opened');
20            }
21        };
22        
23  </script>
24
25</apex:page>

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

メモ

応答

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

名前	型	説明
success	boolean	タブが正常に開かれた場合は `true`、タブが開かれなかった場合は `false`。
id	string	主タブの ID。ID はユーザセッションの間のみ有効です。ユーザが Salesforce コンソールから離れると ID は無効になります。

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

openPrimaryTab()

構文

引数

サンプルコード – Visualforce

応答