Salesforce Console Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Salesforce Console Developer Guide
Lightning Console API
Salesforce Classic API
When to Use the Salesforce Console Integration Toolkit
Salesforce Console Integration Toolkit Support Policy
Change a Visualforce Page by Using the Salesforce Console Integration Toolkit
Working with the Salesforce Console Integration Toolkit
Methods
Methods for Primary Tabs and Subtabs
Methods for Navigation Tabs
Methods for Computer-Telephony Integration (CTI)
Methods for Application-Level Custom Console Components
addToBrowserTitleQueue()
blinkCustomConsoleComponentButtonText()
isCustomConsoleComponentPoppedOut()
isCustomConsoleComponentWindowHidden()
isCustomConsoleComponentHidden()
isInCustomConsoleComponent()
onCustomConsoleComponentButtonClicked()
removeFromBrowserTitleQueue()
runSelectedMacro()
scrollCustomConsoleComponentButtonText()
selectMacro()
setCustomConsoleComponentButtonIconUrl()
setCustomConsoleComponentButtonStyle()
setCustomConsoleComponentButtonText()
setCustomConsoleComponentHeight()
setCustomConsoleComponentVisible()
setCustomConsoleComponentWidth()
setCustomConsoleComponentPopoutable()
setCustomConsoleComponentWindowVisible()
setSidebarVisible()
Methods for Push Notifications
Methods for Console Events
Methods for Chat
Methods for Omni-Channel
Other Resources
PDF

onCustomConsoleComponentButtonClicked()

Registers a function to call when a button is clicked on an application-level custom console component. This method is only available in API version 25.0 or later.

Syntax

sforce.console.onCustomConsoleComponentButtonClicked(eventHandler:Function)

Arguments

Name Type Description
callback function JavaScript method called when a button is clicked on a custom console component.

Sample Code–Visualforce

<apex:page>

    <apex:includeScript value="/support/console/63.0/integration.js"/>
    <script type="text/javascript">
             var eventHandler = function (result) {
                 alert('The Custom Console Component button is clicked. The component ID is: ' + result.id + 
                 ' and the component window is: ' + (result.windowHidden ? 'hidden' : 'visible'));
        };
        
        sforce.console.onCustomConsoleComponentButtonClicked(eventHandler);
    </script>

</apex:page>

Event Handler Response

This method is asynchronous, so it returns its response in an object in a callback method. The response object contains the following field:

Name Type Description
id string The ID of the custom console component which includes the page.
windowHidden boolean true if the custom console component window is hidden after the button is clicked; false if the custom console component window is visible after the button is clicked.