SOAP API Developer Guide

Introduction to SOAP API
Reference
Apex-Related Calls
Core Calls
Describe Calls
describeAllTabs()
describeAppMenu()
DescribeAppMenuResult
describeApprovalLayout()
describeAvailableQuickActions()
describeCompactLayouts()
describeDataCategoryGroups()
describeDataCategoryGroupStructures()
describeGlobal()
describeGlobalTheme()
describeKnowledge()
describeLayout()
describePrimaryCompactLayouts()
describeQuickActions()
describeSearchScopeOrder()
describeSearchLayouts()
describeSObject()
describeSObjects()
describeSoftphoneLayout()
describeSoqlListViews()
describeTabs()
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.

DescribeAppMenuResult

The describeAppMenu() call returns a list of menu items contained in the specified menu type.

The following types are available in API version 29.0 and later.

Name Type Description
appMenuItems DescribeAppMenuItem[] Array of one or more menu items in the selected menu type.

DescribeAppMenuItem

Each DescribeAppMenuItem object has these fields:

Name Type Description
colors DescribeColor[] Array of color information used for the tab associated with the menu item.
content string Information that helps build the menu item. Each menu item has a different type of content for this field. For example, the Salesforce app menu type could contain:
  • FlexiPage—the ID of the Lightning page
  • Visualforce tab—the URL to the page, such as /apex/myApexPage.
Menu items of types other than these don’t use this field.
icons DescribeColor[] Array of icon information used for the tab associated with the menu item.
label string The display label of the menu item.
name string API name of the menu item.
type string The type of menu item, and its subtype, if any. Possible values for the Salesforce app menu type are:
  • Standard.Dashboards—Dashboards menu item
  • Standard.Feed—Chatter feed menu item
  • Standard.Today—the Today menu item
  • Standard.Tasks—Tasks menu item
  • Tab.apexPage—a Visualforce tab menu item
  • Tab.flexipage—a Lightning page tab menu item
url string The Salesforce URL the menu item should point to.

For the Salesforce app menu type, this field is null for the Dashboards, Feed, Today, Tasks, and Lightning page menu items.