closeTab()

Closes a specified primary tab or subtab. Keep in mind that closing the first tab in a primary tab closes the primary tab itself. This method is only available in API version 20.0 or later.

Syntax

The user interface and API behave different for pinned primary tabs. In the UI, when a primary tab is pinned, you can close subtabs using your mouse. However, in the API, if the primary tab is pinned, you can't close its subtabs.

Note

Arguments

Name	Type	Description
id	string	ID of the primary tab or subtab to close.
callback	function	For API version 35.0 or later, the JavaScript method that’s called upon completion of the method.

Sample Code API 20.0 or Later–Visualforce

To see this example in action, click the custom link on a case. For more information, see Define Custom Buttons and Links in the Salesforce help.

Note

Response

None

Sample Code API Version 35.0 or Later–Visualforce

To see this example in action, click the custom link on a case. For more information, see Define Custom Buttons and Links in the Salesforce help.

Note

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	`true` if the tab was re-opened, `false` otherwise.
error	string	Error message if the tab couldn’t be closed.

When using Firefox, we recommend that you don't call closeTab() on a tab with an active alert box because the browser may not load properly.

Tip

Salesforce Console Developer Guide

closeTab()

Syntax

Arguments

Sample Code API 20.0 or Later–Visualforce

Response

Sample Code API Version 35.0 or Later–Visualforce

Response