Salesforce Console Developer Guide
jNote: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.
setCustomConsoleComponentButtonIconUrl()
Sets the button icon URL of an
application-level custom console component that’s on a page. This method is only available in API version 25.0 or
later.
Syntax
1sforce.console.setCustomConsoleComponentButtonIconUrl(iconURL:String, (optional)callback:Function)Arguments
| Name | Type | Description |
|---|---|---|
| iconUrl | string | A URL that points to an image that’s used as a button to launch a custom console component. |
| callback | function | JavaScript method that’s called upon completion of the method. |
Sample Code–Visualforce
1<apex:page>
2
3 <A HREF="#" onClick="testSetCustomConsoleComponentButtonIconUrl();return false">
4 Click here to set the custom console component button icon</A>
5
6 <apex:includeScript value="/support/console/68.0/integration.js"/>
7 <script type="text/javascript">
8 function testSetCustomConsoleComponentButtonIconUrl() {
9 sforce.console.setCustomConsoleComponentButtonIconUrl('http://imageserver/img.png');
10 }
11 </script>
12</apex:page>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 |
|---|---|---|
| success | boolean | true if setting the button icon URL was successful; false if setting the button icon URL wasn't successful. |