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");
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17public void describeAppMenu() {
18    try {
19        //The following two lines are equivalent
20        DescribeAppMenuResult describe = connection.describeAppMenu("Salesforce1");
21        DescribeAppMenuResult appMenu = getClient().describeAppMenu(AppMenuType.Salesforce1);
22
23        for (DescribeAppMenuItem menuItem : appMenu.getAppMenuItems()) {
24
25            if (menuItem.getType() == "Tab.apexPage") {
26
27                String visualforceUrl = menuItem.getContent();
28
29                System.out.println("URL to Visualforce page: " + visualforceUrl);
30
31            }
32
33        }
34
35    } catch (ConnectionException ce) {
36        ce.printStackTrace();
37    }
38}

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