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

Salesforce コンソールインテグレーションツールキット開発者ガイド

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

getPageInfo()

使用方法

指定されたタブのページ情報の内容をロードした後、その情報を返します。タブ ID が null の場合、囲んでいる主タブまたはサブタブのページ情報を返します。カスタムコンソールコンポーネントからページ情報を取得するには、tabId が最初のパラメータとしてこのメソッドに渡される必要があります。このメソッドは、API バージョン 26.0 以降でのみ使用できます。

構文

1sforce.console.getPageInfo(tabId:String, (optional)callback:Function)

引数

名前 型 説明
tabId string ページ情報が返される元となるタブの ID。
callback function メソッドの完了時にコールされる JavaScript メソッド。

サンプルコード – Visualforce

1swfobject.registerObject("clippy.codeblock-1", "9");<apex:page>
2    <A HREF="#" onClick="testGetPageInfo();return false">
3        Click here to get page information</A> 
4
5    <apex:includeScript value="/support/console/26.0/integration.js"/>
6    <script type="text/javascript">
7        function testGetPageInfo() {
8            //Get the page information of 'scc-pt-1'
9           //This value is for example purposes only
10             var tabId = 'scc-pt-1';
11              sforce.console.getPageInfo(tabId , showPageInfo);
12        }
13        
14        var showPageInfo = function showPageInfo(result) {
15            alert('Page Info: ' + result.pageInfo);
16            };
17  </script>
18</apex:page>

応答

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

名前 型 説明
pageInfo string ページの URL。また、該当する場合はページのオブジェクト ID、オブジェクト名、およびオブジェクト種別。このデータは JSON 形式で返されます。次に例を示します。
1{"url":"http://na.salesforce.com/001x0000003DGQR",​"objectId":"001x0000003DGQR","objectName":"Acme","object":"Account"
API バージョン 31.0 以降では、個人取引先オブジェクトで API メソッドを呼び出すと次の追加情報を返します。
  • AccountId または ContactId (関連する取引先または取引先責任者の ID)
  • PersonAccount (オブジェクトが個人取引先の場合は true、それ以外の場合は false)
次に例を示します。
1{"url":"http://na1.salesforce.com/001x0000003DGQR",
2"objectId":"001x0000003DGQR","objectName":"Acme Person Account",
3"object":"Account", "contactId":"003D000000QOMqg", "personAccount":true}
callback function メソッドの完了時にコールされる JavaScript メソッド。