Salesforce Console Integration Toolkit Developer's Guide
jNewer Version Available
blinkCustomConsoleComponentButtonText()
Blinks a button’s text on
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.blinkCustomConsoleComponentButtonText(alternateText:String, interval:number, (optional)callback:Function)Arguments
| Name | Type | Description |
|---|---|---|
| alternateText | string | The alternate text to display when the button text blinks. |
| interval | number | Controls how often the text blinks in milliseconds. |
| 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="testBlinkCustomConsoleComponentButtonText();return false">
20 Click here to blink the button text on a custom console component</A>
21
22 <apex:includeScript value="/support/console/25.0/integration.js"/>
23 <script type="text/javascript">
24 function testBlinkCustomConsoleComponentButtonText() {
25 //Blink the custom console component button text
26 sforce.console.blinkCustomConsoleComponentButtonText('Hello World', 10, function(result){
27 if (result.success) {
28 alert('The text blinking starts!');
29 } else {
30 alert('Could not initiate the text blinking!');
31 }
32 });
33 }
34 </script>
35</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 blinking, the button text was successful; false if blinking the button text wasn't successful. |