Salesforce Console Developer Guide

What Is the Console Developer Guide?
Why Your UI Matters
Lightning Console JavaScript API for Lightning Experience
Salesforce Console Integration Toolkit for Salesforce Classic
When to Use the Salesforce Console Integration Toolkit
Salesforce Console Integration Toolkit Support Policy
Sample Visualforce Page Using the Salesforce Console Integration Toolkit
Working with the Salesforce Console Integration Toolkit
Connecting to the Toolkit
Asynchronous Calls with the Salesforce Console Integration Toolkit
Working with Force.com Canvas
Best Practices
Methods for Salesforce Classic
Methods for Lightning Experience
Events for Lightning Experience
Other Resources
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Connecting to the Toolkit

The first portion of any JavaScript code that uses the Salesforce Console Integration Toolkit must make the toolkit available to the JavaScript code. The syntax for this is different depending on whether you are embedding JavaScript in a Visualforce page, or a third-party domain.
  • For Visualforce pages or any source other than a custom onclick JavaScript button, specify a <script> tag that points to the toolkit file:
    1<apex:page>
2          <script src="/support/console/41.0/integration.js" type="text/javascript"></script>
3     ...
4</apex:page>

    For Visualforce, a relative path is sufficient to include integration.js, and is recommended.

  • For a third-party domain:
    1<script src="https://c.<yourInstance>.visual.force.com/support/console/41.0/integration.js" type="text/javascript"></script>

    For third-party domains, it’s necessary to specify an absolute URL to integration.js to use the toolkit. If you can't determine the org's instance, you can access the toolkit library at the default instance. Contact Salesforce for the default instance’s URL.

The version of the Salesforce Console Integration Toolkit is in the URL.