Salesforce Console Integration Toolkit Developer's Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

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

onCustomConsoleComponentButtonClicked()

Usage

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

Arguments

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

Sample Code–Visualforce

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.