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
Referencing the Canvas SDK
Authentication
Getting Context in Your Canvas App
Cross-Domain XHR
Alternatives to Cookies for User Tracking
Resizing a Canvas App
Implementing Canvas App Events
Canvas App Events Considerations
Creating a Canvas App Event
Subscribing to a Canvas App Event
Unsubscribing from a Canvas App Event
Using Streaming API in a Canvas App
Debugging in a Canvas App
Using the <select> Tag in a Canvas App
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
Reference
PDF

Canvas App Events Considerations

Keep these considerations in mind when implementing canvas app events:
  • We recommend that you use a namespace when naming events, but it’s not required.
  • The event namespace is different than the organization namespace in Salesforce. However, if you use namespaces, we recommend that you make the event namespace the same as the organization namespace.
  • The namespace must be a string with no periods in it. For example, my.name.space.statusChanged is invalid. An example of a valid event name with a namespace is mynamespace.statusChanged.
  • These names are reserved and can’t be used as a namespace:
    • canvas
    • chatter
    • force
    • publisher
    • salesforce
    • sfdc
  • Events work only between canvas apps on the same page. If you have a canvas app on the Chatter tab, that app can’t subscribe to events published by a canvas app on a Visualforce page.
  • You can subscribe to more than one custom event in a subscribe call.
  • You can subscribe to only one Streaming API event in a subscribe call.
  • You can’t subscribe to a custom event and a Streaming API event with the same subscribe call.
  • If you define multiple events with the same name in an array, only the last event defined is available. In this example, the last event where the Status is Negotiating is the one that’s used.
    Sfdc.canvas.client.subscribe(sr.client, [ 
{
    name :"mynamespace.statusChanged",
    payload : {status : 'Closed'}
},
{ 
    name:"mynamespace.statusChanged", 
    payload : {status : 'Negotiating'}
]);

    This is also true for Streaming API events.