describeAppMenu()

Retrieves metadata about items either in the Salesforce1 navigation menu or the Salesforce drop-down app menu. This call is available in API version 29.0 and later.

If you’re accessing the API using a custom community URL, the describeAppMenu() call retrieves the tab set associated with the community.

Syntax

1DescribeAppMenuResult describeResult = connection.describeAppMenu(String appMenuType);

Code Sample—Java

This code sample shows how to get the menu items from the Salesforce1 navigation menu.

1swfobject.registerObject("clippy.codeblock-1", "9");public void describeAppMenu() {
2    try {
3        //The following two lines are equivalent
4        DescribeAppMenuResult describe = connection.describeAppMenu("Salesforce1");
5        DescribeAppMenuResult appMenu = getClient().describeAppMenu(AppMenuType.Salesforce1);
6
7        for (DescribeAppMenuItem menuItem : appMenu.getAppMenuItems()) {
8
9            if (menuItem.getType() == "Tab.apexPage") {
10
11                String visualforceUrl = menuItem.getContent();
12
13                System.out.println("URL to Visualforce page: " + visualforceUrl);
14
15            }
16
17        }
18
19    } catch (ConnectionException ce) {
20        ce.printStackTrace();
21    }
22}

Arguments

Name	Type	Description
appMenuType	string	Restricts the menu data returned to the specified menu type. Valid values are: AppSwitcher—to retrieve the data from the Salesforce drop-down app menu Salesforce1—to retrieve the data from the Salesforce1 navigation menu

Response

DescribeAppMenuResult

Faults

InvalidOrNullForRestrictedPicklist

SOAP API Developer's Guide