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

openSubtabByPrimaryTabName()

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

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

構文

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

引数

名前	型	説明
primaryTabName	string	サブタブが開いている主タブの名前。
url	URL	開いているサブタブの URL。 URL が Salesforce オブジェクトを対象としている場合、そのオブジェクトは、Salesforce コンソールアプリケーション設定で指定したように表示されます。たとえば、ケースを主タブとして開くように設定している場合、ケースで `openSubtab()` がコールされると、ケースは主タブとして開きます。ユーザーは、コンソールの許可リストに追加されている外部 URL を開くことができます。
active	boolean	`true` の場合、開いているサブタブがすぐに表示されます。`false` の場合、開いているサブタブがバックグラウンドで表示され、フォーカスは現在のタブに残ります。
tabLabel	string	開いているサブタブの表示ラベル (省略可能)。表示ラベルが指定されていないと、`外部ページ`が表示され��す。表示ラベルをテキストとして追加します。HTML はサポートされていません。
id	string	上書きするサブタブの ID。新しいサブタブを作成するには、`null` を使用します。
callback	function	メソッドの完了時にコールされる JavaScript メソッド。
name	string	開いているサブタブの名前 (省略可能)。この引数は、API バージョン 22.0 以降でのみ使用できます。

サンプルコード – Visualforce

1<apex:page standardController="Case">
2
3    <A HREF="#" onClick="testOpenSubtab();return false">
4        Click here to open a new subtab by primary tab name</A> 
5
6    <apex:includeScript value="/support/console/60.0/integration.js"/>
7    <script type="text/javascript">
8        function testOpenSubtabByPrimaryTabName() {
9            //First open a primary tab by name
10            sforce.console.openPrimaryTab(null, 'http://www.yahoo.com', true, 'Yahoo', openSubtab, 'yahoo');
11        }
12        
13        var openSubtab = function openSubtab(result) {
14            //Open the subtab by the name specified in function testOpenSubtabByPrimaryTabName()
15            sforce.console.openSubtabByPrimaryTabName('yahoo', 'https://salesforce.com', true, 
16                'salesforce', null, openSuccess);
17        };
18        
19        var openSuccess = function openSuccess(result) {
20            //Report whether we succeeded in opening the subtab
21            if (result.success == true) {
22                alert('subtab successfully opened');
23            } else {
24                alert('subtab cannot be opened');
25            }
26        };
27    </script>
28</apex:page>

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

メモ

応答

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

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

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

openSubtabByPrimaryTabName()

構文

引数

サンプルコード – Visualforce

応答