AppMenuItem

Represents the organization’s default settings for items in the app menu or App Launcher.

Supported Calls

describeSObjects(), query(), retrieve()

Fields

Field Details
ApplicationId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description

The 15-character ID for the menu item.

CanvasAccessMethod
Type
picklist
Properties
Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
Description
The access method for the canvas app. Values can be:
  • OAuth Webflow (GET)
  • Signed Request (POST)
CanvasEnabled
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates if the app menu item is a canvas app (true) or not (false).
CanvasOptions
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Represents the options enabled for a canvas connected app. The options are:
  • PersonalEnabled—The app is enabled as a canvas personal app.
  • HideHeader—The publisher header, which contains the “What are you working on?” text, is hidden.
  • HideShare—The publisher Share button is hidden.
This field is available in API version 34.0 and later.
CanvasReferenceId
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The canvas app unique identifier.
CanvasSelectedLocations
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The selected locations for the canvas app which define where the canvas app can appear in the user interface. For example:
Chatter,ChatterFeed,Publisher,ServiceDesk
CanvasUrl
Type
url
Properties
Filter, Group, Nillable, Sort
Description
The URL of the canvas app.
Description
Type
string
Properties
Filter, Group, Nillable, Sort
Description
A description of this menu item.
IconUrl
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The icon for the menu item’s application.
InfoUrl
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The URL for more information about the application.
IsAccessible
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description

If true, the current user is authorized to use the app.

IsUsingAdminAuthorization
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
If true, the app is pre-authorized for certain users by the administrator.
IsVisible
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description

If true, the app is visible to users of the organization, by default.

Label
Type
string
Properties
Group, Nillable
Description
The app’s name.
LogoUrl
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The logo for the menu item’s application. The default is the initials of the Label value.
MobileStartUrl
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The location mobile users are directed to after they’ve authenticated. This field is only used with connected apps.
Name
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The API name of the item.
NamespacePrefix
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The namespace prefix associated with this object. Each Developer Edition organization that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix__componentName notation.

The namespace prefix can have one of the following values:

  • In Developer Edition organizations, the namespace prefix is set to the namespace prefix of the organization for all objects that support it. There is an exception if an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition organization of the package developer.
  • In organizations that are not Developer Edition organizations, NamespacePrefix is only set for objects that are part of an installed managed package. There is no namespace prefix for all other objects.
SortOrder
Type
int
Properties
Filter, Group, idLookup, Sort
Description
The index value that controls where this item appears in the menu. For example, a menu item with a sort order of 5 appears between items with sort order values of 3 and 9.
StartUrl
Type
string
Properties
Filter, Group, Nillable, Sort
Description
For a connected app, the location users are directed to after they’ve authenticated. Otherwise, the application’s default start page.
Type
Type
string
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The type of application represented by this item. The types are:
  • ConnectedApplication
  • Network
  • ServiceProvider
  • TabSet
UserSortOrder
Type
int
Properties
Filter, Group, Nillable, Sort
Description

The index value that represents where the user set this item in the menu (or App Launcher). For example, an item with a sort order value of 5 appears between items with sort order values of 3 and 9.

This value is separate from SortOrder so you can create logic incorporating both values. For example, if you want the user-sorted items to appear first, followed by the organization order for the rest, use:

SELECT ApplicationId,SortOrder,UserSortOrder FROM AppMenuItem order by userSortOrder NULLS LAST, sortOrder NULLS LAST

Usage

Use this read-only object to view an entry in the Lightning Platform app menu or the App Launcher. You can create a SOQL query to retrieve all items, even items the user does not see from the user interface.

There are many ways you can use AppMenuItem. Here are some examples:
  • Build your own App Launcher or app menu in Salesforce. Create a custom page showing all the apps you have access to and that lets you run them using single sign-on.
  • Build your own App Launcher or app menu on a tablet or mobile app. You can have your own app for launching applications on various mobile devices.
  • Build an app launcher into your company’s intranet. There’s no need to have it run on Salesforce because Salesforce APIs let you integrate with Salesforce programmatically and build an app launcher.
Tip

Tip

To get metadata information about apps and their tabs, use the Apex Schema.describeTabs() method, the REST API /vXX.X/tabs/ resource, or the SOAP API describeTabs() call.