Canvas Developer Guide

Introducing Canvas
Quick Start
Quick Start—Advanced
Canvas SDK
Canvas Apps and Visualforce Pages
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
Objects
CanvasRequest
Client
Context
Application
Environment
Dimensions
Record
Parameters
Version
Links
Organization
User
Controller
SignedRequest
Canvas Limits
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Parameters

The Parameters object is a JSON-formatted object containing context information specified by the developer. The Parameters object is specified in a Visualforce page by using the parameters tag in the apex:canvasApp component, or in a Chatter canvas feed item by using the parameters variable when creating the feed item.

The following code snippet shows an example of the Parameters object.

1"parameters":
2{
3    "inventoryStatus":"Picked",
4    "stockPrice":"12.99",
5    "count":2, 
6    "address":{"street":"1 Market", "city":"San Francisco", "state":"CA"}
7}