generateConsoleUrl()
Salesforce コンソールのタブ、または関連タブのグループへの URL を生成します。外部 URL を含むタブがある場合、正しく表示できるようにコンソールのホワイトリストにその外部 URL を追加します。詳細は、オンラインヘルプの「Salesforce Classic の Salesforce コンソールのホワイトリストのドメイン」を参照してください。このメソッドは、API バージョン 28.0 以降でのみ使用できます。
構文
1sforce.console.generateConsoleUrl(urls:String, (optional)callback:Function)引数
| 名前 | 型 | 説明 |
|---|---|---|
| urls | string | URL の配列。最初の URL が主タブで、それに続く URL がサブタブです。最後の URL は、コンソールがフォーカスされるサブタブです。これらの URL は、標準 Salesforce URL にすることも、相対 URL にすることもできます。 |
| callback | function | メソッドの完了時にコールされる JavaScript メソッド。 |
サンプルコード – Visualforce
1<apex:page>
2 <apex:includeScript value="/support/console/45.0/integration.js"/>
3 <A HREF="#" onClick="testGenerateConsoleURL();return false">
4 Click here to generate a console URL</A>
5
6 <script type="text/javascript">
7 function showConsoleUrl(result) {
8 alert(result.consoleUrl);
9 }
10 function testGenerateConsoleURL() {
11 sforce.console.generateConsoleUrl([/apex/pagename, /entityId, www.externalUrl.com, Standard Salesforce Url/entityId], showConsoleUrl); }
12 </script>
13</apex:page>応答
このメソッドは非同期であるため、コールバックメソッドのオブジェクトで応答を返します。応答オブジェクトには次の項目が含まれます。
| 名前 | 型 | 説明 |
|---|---|---|
| consoleUrl | string | Salesforce に渡される URL の配列を表すコンソール URL。 |
| success | boolean | URL が正常に生成された場合は true、それ以外の場合は false。 |
| callback | function | メソッドの完了時にコールされる JavaScript メソッド。 |