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

Environment

Environment オブジェクトは、キャンバスアプリケーション環境に関するコンテキスト情報を含む、JSON 形式のオブジェクトです。このオブジェクトには、Dimensions オブジェクト、Record オブジェクト、Version オブジェクト、および Parameters オブジェクトのパラメータ (存在する場合) が含まれます。

項目	説明
displayLocation	現在キャンバスアプリケーションをコールしているアプリケーションの場所。有効な値は、次のとおりです。 Chatter — キャンバスアプリケーションが Chatter タブからコールされました。 ChatterFeed — キャンバスアプリケーションが Chatter キャンバスフィード項目からコールされました。 MobileNav — キャンバスアプリケーションがナビゲーションメニューからコールされました。 OpenCTI — キャンバスアプリケーションが Open CTI コンポーネントからコールされました。 PageLayout — キャンバスアプリケーションがページレイアウト内の要素からコールされました。displayLocation が PageLayout の場合、subLocation のいずれかの値が返される可能性があります。 Publisher — キャンバスアプリケーションがキャンバスカスタムクイックアクションからコールされました。 ServiceDesk — キャンバスアプリケーションが Salesforce コンソールコンポーネントからコールされました。 Visualforce — キャンバスアプリケーションが Visualforce ページからコールされました。 None — キャンバスアプリケーションがキャンバスアプリケーションのプレビューアからコールされました。
locationUrl	ユーザがキャンバスアプリケーションにアクセスする Salesforce のページの URL。たとえば、Chatter タブのリンクをクリックしてユーザがキャンバスアプリケーションにアクセスする場合、この項目には Chatter タブの URL が含まれます。
subLocation	キャンバスアプリケーションがモバイルデバイスに読み込まれるときにそのキャンバスアプリケーションのコール元となる、アプリケーション内のサブロケーション。subLocation は displayLocation に関連しています。displayLocation が PageLayout の場合のこの項目の有効な値は、次のとおりです。 S1MobileCardFullview — キャンバスアプリケーションがモバイルカードからコールされました。 S1MobileCardPreview — キャンバスアプリケーションがモバイルカードプレビューからコールされました。アプリケーションを開くには、プレビューをクリックする必要があります。 S1RecordHomePreview — キャンバスアプリケーションがレコード詳細ページプレビューからコールされました。アプリケーションを開くには、プレビューをクリックする必要があります。 S1RecordHomeFullview — キャンバスアプリケーションがページレイアウトからコールされました。
uiTheme	コンテキスト組織のデフォルトのテーマ。

次のコードスニペットに、Environment オブジェクトの例を示します。

1"environment": 
2{ 
3    "parameters":{},
4    "dimensions":
5    { 
6        "clientHeight": "50px", 
7        "clientWidth": "70px", 
8        "height":"900px", 
9        "width":"800px",
10        "maxHeight":"2000px", 
11        "maxWidth":"1000px"
12 
13    }, 
14    "record": {
15        "attributes": {
16            "type": "Account",
17            "url": "/services/data/v58.0/sobjects/Account/001xx000003DGWiAAO"
18        },
19            "Id": "001xx000003DGWiAAO",
20            "Phone": "(555) 555-5555",
21            "Fax": "(555) 555-5555",
22            "BillingCity": "Seattle"
23    },
24    "displayLocation":"PageLayout", 
25    "locationUrl":"https://salesforce.com/some/path/index.html", 
26    "subLocation":"S1MobileCardFullview",
27    "uiTheme":"Theme3",
28    "version":
29    { 
30        "api":"58.0", 
31        "season":"SUMMER" 
32     }
33}

Canvas 開発者ガイド

Environment

関連項目: