Newer Version Available

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

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

1<apex:page>
2
3    <A HREF="#" onClick="testBlinkCustomConsoleComponentButtonText();return false">
4         Click here to blink the button text on a custom console component</A> 
5
6    <apex:includeScript value="/support/console/56.0/integration.js"/>
7    <script type="text/javascript">
8        function testBlinkCustomConsoleComponentButtonText() {
9        //Blink the custom console component button text
10            sforce.console.blinkCustomConsoleComponentButtonText('Hello World', 10, function(result){
11              if (result.success) {
12               alert('The text blinking starts!');
13              } else {
14               alert('Could not initiate the text blinking!');
15              }
16            });
17           }
18    </script>
19</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.