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

1swfobject.registerObject("clippy.codeblock-1", "9");
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17<apex:page>
18
19    <A HREF="#" onClick="testSetCustomConsoleComponentButtonIconUrl();return false">
20         Click here to set the custom console component button icon</A> 
21
22    <apex:includeScript value="/support/console/25.0/integration.js"/>
23    <script type="text/javascript">
24        function testSetCustomConsoleComponentButtonIconUrl() {
25            sforce.console.setCustomConsoleComponentButtonIconUrl('http://imageserver/img.png');
26        }
27    </script>
28</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.

Salesforce Console Integration Toolkit Developer's Guide

setCustomConsoleComponentButtonIconUrl()

Syntax

Arguments

Sample Code–Visualforce

Response