NavigationMenu Class

API Version

52.0

Available to Guest Users

52.0

Requires Chatter

No

Signature

public static ConnectApi.NavigationMenuItemCollection getCommunityNavigationMenu(String communityId, String navigationLinkSetId, String navigationLinkSetDeveloperName, ConnectApi.PublishStatus publishStatus, Boolean includeImageUrl, Boolean addHomeMenuItem, List<ConnectApi.NavigationMenuItemType> menuItemTypesToSkip)

Parameters

communityId

Type: String

ID of an Experience Cloud site.

navigationLinkSetId

Type: String

ID of the navigation link set.

navigationLinkSetDeveloperName

Type: String

Developer name of the navigation link set.

publishStatus

Type: ConnectApi.PublishStatus

Publish status of the navigation menu item. Values are:

• Draft
• Live

includeImageUrl

Type: Boolean

Specifies whether to include the image URL with the menu item (true) or not (false).

addHomeMenuItem

Type: Boolean

Specifies whether to add the Home menu item (true) or not (false).

menuItemTypesToSkip

Type: List<ConnectApi.NavigationMenuItemType>

List of menu item types to filter out of the results. Values are:

• Event—Event, such as logging in, logging out, or switching accounts.
• ExternalLink—URL outside of your site.
• GlobalAction—Lets users create records that aren’t related to other records.
• InternalLink—Relative URL inside your site.
• MenuLabel—Menu label.
• NavigationalTopic—Dropdown list with links to the navigational topics in your site.
• SalesforceObject—Objects such as accounts, cases, contacts, and custom objects.
• SystemLink—System link, such as a link to Builder, Workspaces, or Setup.

Return Value

Type: ConnectApi.NavigationMenuItemCollection