Newer Version Available

This content describes an older version of this product. View Latest

NavigationMenuItem

Represents a single menu item in a NavigationLinkSet. Use this object to create, delete, or update menu items in your community’s navigation menu. This object is available in API version 36.0 and later.

Supported Calls

create()delete()describeSObjects()query()retrieve()update()upsert()

Special Access Rules

Fields

Field Name Details
AccessRestriction
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
Determines if the menu item is available to guest users who aren’t required to log in to the community.
DefaultListViewId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
If the value of the Type field is SalesforceObject, the value is the ID of the default list view for the object.
Label
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The text that appears in the navigation menu for this item.
NavigationLinkSetId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The navigation menu that this item is included in.
Position
Type
int
Properties
Create, Filter, Group, Sort, Update
Description
The location of the menu item in the navigation menu.
Target
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
If Type is ExternalLink or InternalLink, the target is the URL that the link points to. For ExternalLink, your entry looks like this: http://www.salesforce.com. For InternalLink, use a relative URL, such as /contactsupport.
Type
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
The type of navigation menu item. The available values are:
  • SalesforceObject—Available objects include accounts, cases, contacts, and custom objects.
  • ExternalLink—Links to a URL outside of your community. For example, http://www.salesforce.com.
  • InternalLink—Links to a relative URL inside your community. For example, /contactsupport.
  • NavigationalTopic—A drop-down list with links to the navigational topics in your community.

Usage

You can add up to 20 navigation menu items. You can translate navigation menu items using the Translation Workbench.