Environment オブジェクトは、キャンバスアプリケーション環境に関するコンテキスト情報を含む、JSON 形式のオブジェクトです。このオブジェクトには、Dimensions オブジェクト、Record オブジェクト、Version オブジェクト、および Parameters オブジェクトのパラメータ (存在する場合) が含まれます。
| displayLocation |
現在キャンバスアプリケーションをコールしているアプリケーションの場所。有効な値は、次のとおりです。
- Chatter — キャンバスアプリケーションが Chatter タブからコールされました。
- ChatterFeed — キャンバスアプリケーションが Chatter キャンバスフィード項目からコールされました。
- MobileNav — キャンバスアプリケーションが Salesforce1 のナビゲーションメニューからコールされました。
- 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 オブジェクトの例を示します。
j