Newer Version Available

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

addToBrowserTitleQueue()

Adds a browser tab title to a list of titles, which rotates every three seconds. This method is only available in API version 28.0 or later.

Syntax

1sforce.console.addToBrowserTitleQueue( title:String, callback:Function )

Arguments

Name Type Description
title string Browser tab title that is displayed.
callback function JavaScript method that’s called upon completion of the method.

Sample Code–Visualforce

1<apex:page >
2    <A HREF="#" onClick="testAddToBrowserTitleQueue();return false">
3            Click here to enqueue a browser title</A>
4
5    <apex:includeScript value="/support/console/60.0/integration.js"/>
6    <script type="text/javascript">
7                 function testAddToBrowserTitleQueue() {
8             var title = 'TestTitle';
9          sforce.console.addToBrowserTitleQueue(title);
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 fields:

Name Type Description
success boolean If true, the title was successfully added to the browser title queue. If false, the title wasn’t added to the browser title queue.
callback function JavaScript method that’s called upon completion of the method.