Force.com Apex Code Developer's Guide

Getting Started
Writing Apex
Ways to Invoke Apex
Finishing Touches
Reference
Apex DML Operations
ApexPages Namespace
Approval Namespace
Auth Namespace
Canvas Namespace
ApplicationContext Interface
CanvasLifecycleHandler Interface
ContextTypeEnum Enum
EnvironmentContext Interface
RenderContext Interface
RenderContext Methods
getApplicationContext()
getEnvironmentContext()
Test Class
Canvas Exceptions
ChatterAnswers Namespace
ConnectApi Namespace
Database Namespace
Datacloud Namespace
DataSource Namespace
Dom Namespace
Flow Namespace
KbManagement Namespace
Messaging Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
Schema Namespace
Search Namespace
Site Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
UserProvisioning Namespace
Appendices
Glossary
PDF

Newer Version Available

This content describes an older version of this product. View Latest

getEnvironmentContext()

Retrieves the environment context information.

Signature

public Canvas.EnvironmentContext getEnvironmentContext()

Return Value

Type: Canvas.EnvironmentContext

Usage

Use this method to get the environment context information for your canvas app.

Example

The following example implementation of the CanvasLifecycleHandler onRender() method uses the provided RenderContext to retrieve the environment context information and then modifies the custom parameters.