主タブとサブタブ用のメソッド

Salesforce コンソールには、Salesforce ページが主タブまたはサブタブとして表示されます。主タブには、取引先など、作業する主な項目が表示されます。サブタブには、取引先の取引先責任者や商談など、関連項目が表示されます。

コンソールの主タブまたはサブタブには、次のメソッドを使用できます。

メソッド	説明
closeTab()	指定された主タブまたはサブタブを閉じます。主タブの最初のタブを閉じると、主タブそのものが閉じるので注意してください。このメソッドは、API バージョン 20.0 以降でのみ使用できます。
focusPrimaryTabById()	指定された ID を使用して、ブラウザですでに開いている主タブにフォーカスを移動します。このメソッドは、API バージョン 22.0 以降でのみ使用できます。
focusPrimaryTabByName()	指定された名前を使用して、ブラウザですでに開いている主タブにフォーカスを移動します。このメソッドは、API バージョン 22.0 以降でのみ使用できます。
focusSubtabById()	指定された ID を使用して、ブラウザですでに開いているサブタブにフォーカスを移動します。このメソッドは、API バージョン 22.0 以降でのみ使用できます。
focusSubtabByNameAndPrimaryTabId()	指定された名前と主タブ ID を使用して、ブラウザですでに開いているサブタブにフォーカスを移動します。このメソッドは、API バージョン 22.0 以降でのみ使用できます。
focusSubtabByNameAndPrimaryTabName()	指定された名前と主タブ名を使用して、ブラウザですでに開いているサブタブにフォーカスを移動します。このメソッドは、API バージョン 22.0 以降でのみ使用できます。
generateConsoleUrl()	Salesforce コンソールのタブ、または関連タブのグループへの URL を生成します。外部 URL を含むタブがある場合、正しく表示できるようにコンソールのホワイトリストにその外部 URL を追加します。詳細は、オンラインヘルプの「Salesforce コンソールのホワイトリストのドメイン」を参照してください。このメソッドは、API バージョン 28.0 以降でのみ使用できます。
getEnclosingPrimaryTabId()	現在の主タブの ID を返します。このメソッドは主タブまたはサブタブ内で機能します。ナビゲーションタブやカスタムコンソールコンポーネント内では機能しません。このメソッドは、API バージョン 20.0 以降でのみ使用できます。
getEnclosingPrimaryTabObjectId()	サブタブを含む、現在の主タブのオブジェクト ID を返します。たとえば、ケース ID や取引先 ID などです。このメソッドは、主タブまたはサブタブ内で機能します。このメソッドは、API バージョン 24.0 以降でのみ使用できます。
getEnclosingTabId()	主タブまたはサブタブである可能性のある、現在の Visualforce ページを含むタブの ID を返します。このメソッドは、サブタブで囲まれたコンポーネントからコールが行われる場合に機能します。このメソッドは、API バージョン 20.0 以降でのみ使用できます。
getFocusedPrimaryTabId()	ブラウザがフォーカスされている主タブの ID を返します。このメソッドは、API バージョン 25.0 以降でのみ使用できます。
getFocusedPrimaryTabObjectId()	ブラウザがフォーカスされている主タブのオブジェクト ID を返します。このメソッドは、API バージョン 25.0 以降でのみ使用できます。
getFocusedSubtabId()	ブラウザがフォーカスされているサブタブの ID を返します。たとえば、ケース ID や取引先 ID などです。このメソッドは、API バージョン 25.0 以降でのみ使用できます。
getFocusedSubtabObjectId()	ブラウザがフォーカスされているサブタブのオブジェクト ID を返します。たとえば、ケース ID や取引先 ID などです。このメソッドは、API バージョン 24.0 以降でのみ使用できます。
getPageInfo()	指定されたタブのページ情報の内容をロードした後、その情報を返します。タブ ID が null の場合、囲んでいる主タブまたはサブタブのページ情報を返します。カスタムコンソールコンポーネントからページ情報を取得するには、tabId が最初のパラメータとしてこのメソッドに渡される必要があります。このメソッドは、API バージョン 26.0 以降でのみ使用できます。
getPrimaryTabIds()	開いている主タブのすべての ID を返します。このメソッドは、API バージョン 26.0 以降でのみ使用できます。
getSubtabIds()	主タブ ID によって指定された主タブ上にあるサブタブのすべての ID を返します。主タブ ID が null の場合、現在の主タブ上にあるサブタブの ID を返します。このメソッドは、カスタムコンソールコンポーネント、または Visualforce ページによって上書きされた詳細ページからのみコールできます。このメソッドは、API バージョン 26.0 以降でのみ使用できます。
getTabLink()	Salesforce コンソールのタブ、または関連タブのグループへの URL を取得します。このメソッドは、API バージョン 28.0 以降でのみ使用できます。
isInConsole()	ページが Salesforce コンソールにあるかどうかを判断します。このメソッドは、API バージョン 22.0 以降でのみ使用できます。
onEnclosingTabRefresh()	囲んでいるタブが更新されるとコールされる関数を登録します。このメソッドは、API バージョン 24.0 以降でのみ使用できます。
onFocusedSubtab()	ブラウザのフォーカスが異なるサブタブに変更されるとコールされる関数を登録します。このメソッドは、API バージョン 24.0 以降でのみ使用できます。
onTabSave()	ユーザがサブタブの [保存されていない変更] ダイアログボックスの [保存] をクリックすると、コールバックメソッドを登録し、コールします。このメソッドを使用する場合、コールバックメソッドで setTabUnsavedChanges() をコールする必要があります。これにより、カスタム保存操作が完了したことがコンソールに通知されます。setTabUnsavedChanges() へのコールでは、保存が成功したことを示すには、最初のパラメータとして false を渡し、保存が失敗したことを示すには、true を渡します。このメソッドは、API バージョン 28.0 以降でのみ使用できます。
openConsoleUrl()	generateConsoleUrl() メソッドで作成した URL (Salesforce コンソールのタブ、または関連タブのグループへの URL) を開きます。このメソッドは、API バージョン 28.0 以降でのみ使用できます。
openPrimaryTab()	指定された URL (相対または絶対) のコンテンツを表示する新しい主タブを開きます。また、既存のタブを上書きすることもできます。このメソッドは、API バージョン 20.0 以降でのみ使用できます。
openSubtab()	指定された URL (相対または絶対) のコンテンツを表示する新しいサブタブ (主タブ内) を開きます。また、既存のサブタブを上書きすることもできます。主タブの ID を使用して主タブで新しいサブタブを開く場合に使用します。このメソッドは、API バージョン 20.0 以降でのみ使用できます。
openSubtabByPrimaryTabName()	指定された URL (相対または絶対) のコンテンツを表示する新しいサブタブ (主タブ内) を開きます。また、既存のサブタブを上書きすることもできます。主タブの名前を使用して主タブで新しいサブタブを開く場合に使用します。このメソッドは、API バージョン 22.0 以降でのみ使用できます。
refreshPrimaryTabById()	サブタブを含む、ID で指定された主タブを更新します。このメソッドでは、外部ページまたは Visualforce ページへの URL を持つサブタブは更新できません。このメソッドは、API バージョン 22.0 以降でのみ使用できます。
refreshPrimaryTabByName()	サブタブを含む、名前で指定された主タブを更新します。このメソッドでは、外部ページまたは Visualforce ページへの URL を持つサブタブは更新できません。このメソッドは、API バージョン 22.0 以降でのみ使用できます。
refreshSubtabById()	指定された ID で最後に確認された URL を持つサブタブを更新します。最後に確認された URL が外部ページまたは Visualforce ページの場合、このメソッドではサブタブを更新できません。このメソッドは、API バージョン 22.0 以降でのみ使用できます。
refreshSubtabByNameAndPrimaryTabId()	指定された名前と主タブ ID で最後に確認された URL を持つサブタブを更新します。最後に確認された URL が外部ページまたは Visualforce ページの場合、このメソッドではサブタブを更新できません。このメソッドは、API バージョン 22.0 以降でのみ使用できます。
refreshSubtabByNameAndPrimaryTabName()	指定された名前と主タブ名で最後に確認された URL を持つサブタブを更新します。最後に確認された URL が外部ページまたは Visualforce ページの場合、このメソッドではサブタブを更新できません。このメソッドは、API バージョン 22.0 以降でのみ使用できます。
resetSessionTimeOut()	Visualforce ページのセッションタイムアウトをリセットします。これにより、ユーザがログアウトせず操作を続行できます。詳細は、「セッションセキュリティの設定」を参照してください。このメソッドは、API バージョン 24.0 以降でのみ使用できます。
setTabLink()	コンソールタブの URL 属性をタブのコンテンツの場所に設定します。ユーザが Salesforce ドメインの外にあるコンテンツを表示したタブに移動するときは、このメソッドを使用して安全なコンソール URL を生成します。このメソッドは、API バージョン 28.0 以降でのみ使用できます。
setTabIcon()	指定されたタブにアイコンを設定します。タブが指定されていない場合、アイコンは囲んでいるタブに設定されます。このメソッドを使って、タブのアイコンをカスタマイズします。このメソッドは、API バージョン 28.0 以降でのみ使用できます。
setTabStyle()	指定のタブにカスケードスタイルシート (CSS) を設定します。タブが指定されていない場合、CSS は囲んでいるタブに設定されます。このメソッドを使って、タブのデザインをカスタマイズします。このメソッドは、API バージョン 28.0 以降でのみ使用できます。
setTabTextStyle()	指定されたタブのテキストにカスケードスタイルシート (CSS) を設定します。タブが指定されていない場合、CSS は囲んでいるタブのテキストに設定されます。このメソッドを使って、タブのテキストスタイルをカスタマイズします。このメソッドは、API バージョン 28.0 以降でのみ使用できます。
setTabTitle()	主タブまたはサブタブのタイトルを設定します。このメソッドは、API バージョン 20.0 以降でのみ使用できます。
setTabUnsavedChanges()	未保存のデータを示すため、サブタブの保存されていない変更アイコン () を設定します。このメソッドは、API バージョン 23.0 以降でのみ使用できます。