Force.com Apex Code Developer's Guide
Summer '26 (API version 67.0)
Spring '26 (API version 66.0)
Winter '26 (API version 65.0)
Summer '25 (API version 64.0)
Spring '25 (API version 63.0)
Winter '25 (API version 62.0)
Summer '24 (API version 61.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Spring '21 (API version 51.0)
Winter '21 (API version 50.0)
Summer '20 (API version 49.0)
Spring '20 (API version 48.0)
Winter '20 (API version 47.0)
Summer '19 (API version 46.0)
Spring '19 (API version 45.0)
Winter '19 (API version 44.0)
Summer '18 (API version 43.0)
Spring '18 (API version 42.0)
Winter '18 (API version 41.0)
Summer '17 (API version 40.0)
Spring '17 (API version 39.0)
Winter '17 (API version 38.0)
Summer '16 (API version 37.0)
Spring '16 (API version 36.0)
Winter '16 (API version 35.0)
Summer '15 (API version 34.0)
Spring '15 (API version 33.0)
Winter '15 (API version 32.0)
Spring '14 (API version 30.0)
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Newer Version Available
EnvironmentContext Methods
The following are methods for EnvironmentContext.
- addEntityField(String)
Adds a field to the list of object fields that are returned in the signed request Record object when the component appears on a Visualforce page that’s placed on an object. - addEntityFields(Set<String>)
Adds a set of fields to the list of object fields that are returned in the signed request Record object when the component appears on a Visualforce page that’s placed on an object. - getDisplayLocation()
Retrieves the display location where the canvas app is being called from. For example, a value of Visualforce indicates that the canvas app was called from a Visualforce page. - getEntityFields()
Retrieves the list of object fields that are returned in the signed request Record object when the component appears on a Visualforce page that’s placed on an object. - getLocationUrl()
Retrieves the location URL of the canvas app. - getParametersAsJSON()
Retrieves the current custom parameters for the canvas app. Parameters are returned as a JSON string. - getSublocation()
Retrieves the display sublocation where the canvas app is being called from. - setParametersAsJSON(String)
Sets the custom parameters for the canvas app.