getTabLink()

Retrieves the URL to a tab, or group of related tabs, from the Salesforce console. This method is only available in API version 28.0 or later.

Syntax

sforce.console.getTabLink(level:String, (optional)tabId:String, (optional)callback:Function)

Arguments

Name Type Description
level string Level that matches one of the Link to Share options in the Salesforce console user interface. The options are:
  • All primary tabs and subtabs — sforce.console.TabLink.PARENT_AND_CHILDREN.
  • Only the specified tab — sforce.console.TabLink.TAB_ONLY
  • A standard Salesforce URL — sforce.console.TabLink.SALESFORCE_URL
tabId string Optional tab ID of the tab from which you’re retrieving the URL. If you do not pass a tab ID, the URL to the current tab is returned.
callback function JavaScript method that’s called upon completion of the method.

Sample Code–Visualforce

<apex:page>
    <apex:includeScript value="/support/console/64.0/integration.js"/>
    <A HREF="#" onClick="getEnclosingPrimaryTabId();return false">
        Click here to get tab link</A> 

    <script type="text/javascript">
        var getEnclosingPrimaryTabId = function getEnclosingPrimaryTabId() {
            sforce.console.getEnclosingPrimaryTabId(getTabLink);
        }
        var getTabLink = function getTabLink(result) {
            sforce.console.getTabLink(sforce.console.TabLink.PARENT_AND_CHILDREN, result.id, showTabLink);
        }
        var showTabLink = function showTabLink(result) {
            var link = result.tabLink;
            };
  </script>
</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
tabLink string The retrieved URL.
success boolean true if the link was retrieved successfully, false if retrieving was unsuccessful.
callback function JavaScript method that’s called upon completion of the method.