SOAP API Developer Guide

Introduction to SOAP API
Reference
Apex-Related Calls
Core Calls
Describe Calls
describeAllTabs()
describeAppMenu()
describeApprovalLayout()
describeAvailableQuickActions()
describeCompactLayouts()
describeDataCategoryGroups()
describeDataCategoryGroupStructures()
describeGlobal()
describeGlobalTheme()
describeKnowledge()
describeLayout()
describePrimaryCompactLayouts()
describeQuickActions()
describeSearchScopeOrder()
describeSearchLayouts()
describeSObject()
describeSObjects()
describeSoftphoneLayout()
describeSoqlListViews()
describeTabs()
DescribeTabSetResult
DescribeColor
DescribeIcon
DescribeTab
describeTheme()
Utility Calls
SOAP Headers
Using the API with Salesforce Features
Glossary
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

DescribeIcon

DescribeIcon contains icon metadata information for a tab.

The describeTabs() call returns an array of DescribeTabSetResult values. Each DescribeTabSetResult contains an array of DescribeTab values, and each DescribeTab contains an array of DescribeIcon values.

Icon information can also be retrieved via the describeTheme() and describeGlobalTheme() calls. These calls return information on icons used for each object in your organization that can use theme icons and colors.

Name Type Description
contentType string The tab icon’s content type, for example, “image/png.”
height int The tab icon’s height in pixels. If the icon content type is an SVG type, height and width values are not used.
theme string
The associated theme. Possible values include:
  • theme2—Theme used prior to Spring ’10, called the “Salesforce Classic 2005 user interface theme”
  • theme3—Theme introduced in Spring ’10, called the “Salesforce Classic 2010 user interface theme”
  • theme4—Theme introduced in Winter ’14 for the mobile touchscreen version of Salesforce, and in Winter ’16 for Lightning Experience
  • custom—Theme associated with a custom icon
url string The fully qualified URL for this icon.
width string The tab icon’s width in pixels. If the icon content type is an SVG type, height and width values are not used.