Canvas Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Getting Started
Using Canvas
Canvas SDK
Canvas Apps and Visualforce Pages
Visualforce Page Code Examples
Visualforce Considerations
apex:canvasApp Component
Returning Fields in the Record Object
Using Events between a Visualforce Page and a Canvas App
Lightning Component Code Examples
Canvas Apps in a Page Layout or a Mobile Card
Canvas Apps in the Publisher
Canvas Apps in the Chatter Feed
Canvas in the Salesforce Mobile App
Customizing Your App Lifecycle
Reference
PDF

Returning Fields in the Record Object

When you use the <apex:canvasApp> component to display a canvas app on a Visualforce page, and that page is associated with an object (placed on the page layout, for example), you can specify fields to be returned from the related object. To do this, use the entityFields attribute. You can use this attribute in one of the following ways.

Return Specific Object Fields

You can return specific object fields in the Record object by setting the entityFields attribute to a comma-separated list of field names. If there’s an invalid field name in the list, then that field name is ignored and the valid fields are returned in the Record object.
<apex:canvasApp applicationName="MyApp" entityFields="Phone,Fax,BillingCity" containerId="canvasAppDiv"/>
returns a Record object that looks like this:
"record":{
    "attributes":{
        "type":"Account",
        "url":"/services/data/v63.0/sobjects/Account/001xx000003DGWiAAO"
        },
    "Id":"001xx000003DGWiAAO",
    "Phone":"(555) 555-5555",
    "Fax":"(555) 555-5555",
    "BillingCity":"Seattle"
    }

Return All Object Fields

You can return all object fields in the Record object by setting the entityFields attribute to the wildcard "*".
<apex:canvasApp applicationName="MyApp" entityFields="*" containerId="canvasAppDiv"/>
returns a Record object that looks like this:
"record":{
    "attributes":{
        "type":"Account",
        "url":"/services/data/v63.0/sobjects/Account/001xx000003DGWiAAO"
        },
    "Id":"001xx000003DGWiAAO",
    "IsDeleted":false,
    "MasterRecordId":null,
    "Name":"Edge Communications",
    "Type":"Customer - Channel",
    "ParentId":null,
    "BillingStreet":"123 Main Street",
    "BillingCity":"Seattle",
    "BillingState":"WA",
    "BillingPostalCode":"98121",
    "BillingCountry":"USA",
...
    }

Return the Id Field

If the <apex:canvasApp> component doesn’t have the entityFields attribute or if the attribute is blank, then only the Id field is returned in the Record object.
<apex:canvasApp applicationName="MyApp" containerId="canvasAppDiv"/>
returns a Record object that looks like this:
"record":{
    "attributes":{
        "type":"Account",
        "url":"/services/data/v63.0/sobjects/Account/001xx000003DGWiAAO"
        },
    "Id":"001xx000003DGWiAAO"
    }