Apex Reference Guide
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)
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Release Notes
ContextTypeEnum Enum
addEntityField(fieldName)
addEntityFields(fieldNames)
getDisplayLocation()
getEntityFields()
getLocationUrl()
getParametersAsJSON()
getSublocation()
setParametersAsJSON(jsonString)
Canvas Exceptions
CommerceOrders Namespace
ComplianceMgmt Namespace
Context Namespace
DataRetrieval Namespace
ExternalService Namespace
Flowtesting Namespace
IndustriesDigitalLending Namespace
InvoiceWriteOff Namespace
PlaceQuote Namespace
RevSignaling Namespace
RevSalesTrxn Namespace
Slack Namespace
EnvironmentContext Methods
The following are methods for EnvironmentContext.
-
addEntityField(fieldName)
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(fieldNames)
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 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(jsonString)
Sets the custom parameters for the canvas app.