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.

NameTypeDescription
callbackfunctionJavaScript method called when a button is clicked on a custom console component.

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

NameTypeDescription
idstringThe ID of the custom console component which includes the page.
windowHiddenbooleantrue 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.