DescribeTabSetResult Class

Contains metadata information about a Salesforce Classic standard or custom app available in the Salesforce user interface.

Schema

The Schema.describeTabs method returns a list of Schema.DescribeTabSetResult objects that describe Salesforce Classic standard and custom apps.

The methods in the Schema.DescribeTabSetResult class can be called using their property counterparts. For each method starting with get, you can omit the get prefix and the ending parentheses () to call the property counterpart. For example, tabSetResultObj.label is equivalent to tabSetResultObj.getLabel(). Similarly, for each method starting with is, omit the is prefix and the ending parentheses (). For example, tabSetResultObj.isSelected is equivalent to tabSetResultObj.selected.

This example shows how to call the Schema.describeTabs method to get describe information for all available Salesforce Classic apps. This example iterates through each describe result and gets more metadata information for the Sales app.

The following are methods for DescribeTabSetResult. All are instance methods.

• getDescription()

  Returns the display description for the standard or custom app.

• getLabel()

  Returns the display label for the standard or custom app.

• getLogoUrl()

  Returns a fully qualified URL to the logo image associated with the standard or custom app.

• getNamespace()

  Returns the developer namespace prefix of a Salesforce AppExchange managed package.

• getTabs()

  Returns metadata information about the standard or custom app’s displayed tabs.

• isSelected()

  Returns true if this standard or custom app is the user’s currently selected app in Salesforce Classic. Otherwise, returns false.

Returns the display description for the standard or custom app.

public String getDescription()

Type: String

Returns the display label for the standard or custom app.

public String getLabel()

Type: String

The display label changes when tabs are renamed in the Salesforce user interface. See the Salesforce online help for more information.

Returns a fully qualified URL to the logo image associated with the standard or custom app.

public String getLogoUrl()

Type: String

Returns the developer namespace prefix of a Salesforce AppExchange managed package.

public String getNamespace()

Type: String

This namespace prefix corresponds to the namespace prefix of the Developer Edition organization that was enabled to allow publishing a managed package. This method applies to a custom app containing a set of tabs and installed as part of a managed package.

Returns metadata information about the standard or custom app’s displayed tabs.

public List<Schema.DescribeTabResult> getTabs()

Type: List<Schema.DescribeTabResult>

Returns true if this standard or custom app is the user’s currently selected app in Salesforce Classic. Otherwise, returns false.

public Boolean isSelected()

Type: Boolean