Apex Reference Guide

Apex Reference Guide
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommercePayments Namespace
ConnectApi Namespace
ActionLinks Class
Announcements Class
CdpQuery Class
Chatter Class
ChatterFavorites Class
ChatterFeeds Class
ChatterGroups Class
ChatterMessages Class
ChatterUsers Class
CommerceBuyerExperience Class
CommerceCart Class
CommerceCatalog Class
CommerceSearch Class
CommerceSearchSettings Class
CommerceStorePricing Class
CommerceWishlist Class
Communities Class
CommunityModeration Class
ContentHub Class
Datacloud Class
EmailMergeFieldService Class
EmployeeProfiles Class
ExternalEmailServices Class
ExternalManagedAccount Class
FieldService Class
FulfillmentOrder Class
Knowledge Class
LightningScheduler Class
ManagedContent Class
ManagedContentDelivery Class
ManagedTopics Class
MarketingIntegration Class
Mentions Class
Missions Class
NavigationMenu Class
NavigationMenu Methods
NextBestAction Class
OmnichannelInventoryService Class
Orchestration Class
OrderPaymentSummary Class
OrderSummary Class
OrderSummaryCreation Class
Organization Class
Payments Methods
Personalization Class
QuestionAndAnswers Class
Recommendations Class
Records Class
ReturnOrder Class
Routing Class
SalesforceInbox Class
Sites Class
SmartDataDiscovery Class
SocialEngagement Class
Survey Class
Topics Class
UserProfiles Class
Zones Class
ConnectApi Input Classes
ConnectApi Output Classes
ConnectApi Enums
ConnectApi Exceptions
Database Namespace
Datacloud Namespace
DataSource Namespace
Dom Namespace
EventBus Namespace
Flow Namespace
Functions Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
Schema Namespace
Search Namespace
Sfc Namespace
Sfdc_Checkout Namespace
sfdc_surveys Namespace
Site Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

Newer Version Available

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

NavigationMenu Class

Get navigation menu items for an Experience Cloud site.

Namespace

ConnectApi

NavigationMenu Methods

These methods are for NavigationMenu. All methods are static.

getCommunityNavigationMenu(communityId, navigationLinkSetId, navigationLinkSetDeveloperName, publishStatus, includeImageUrl, addHomeMenuItem, menuItemTypesToSkip)

Get navigation menu items for an Experience Cloud site.

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).

Data Source menu item types with a Storefront Categories data source aren’t supported when includeImageUrl is true.

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

Usage

Supported navigation menu item types 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.

getCommunityNavigationMenu(communityId, navigationLinkSetId, navigationLinkSetDeveloperName, publishStatus, includeImageUrl, addHomeMenuItem, menuItemTypesToSkip, effectiveAccountId)

Get navigation menu items for an Experience Cloud based on an effective account.

API Version

54.0

Available to Guest Users

54.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, String effectiveAccountId)

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).

Data Source menu item types with a Storefront Categories data source aren’t supported when includeImageUrl is true.

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.
effectiveAccountId
Type: String
ID of the account for which the request is made. If unspecified, defaults to the account ID for the context user.

Return Value

Type: ConnectApi.NavigationMenuItemCollection

Usage

Supported navigation menu item types 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.