Click or drag to resize

ICMSNavigationBuilderGetPageEntries Method

Gets the navigation representatives for the given page IDs. It will build the representatives first, in case an entry does not exist or expired.

Namespace:  Ingeniux.Runtime.NavigationBuilder
Assembly:  IGXRuntimeAPI (in IGXRuntimeAPI.dll) Version: 10.6.308
Syntax
IEnumerable<ICMSNavEntry> GetPageEntries(
	ICMSNavigationBuildingSession session,
	IEnumerable<string> pageIds,
	bool isbackground,
	List<string> badEntryIds,
	IEnumerable<string> filterSchemaNames = null,
	IEnumerable<string> filterAncestorPageIds = null,
	bool useCheckedOut = false,
	bool skipBuildingExistingEntries = false
)

Parameters

session
Type: Ingeniux.Runtime.NavigationBuilderICMSNavigationBuildingSession
Navigation building session to retrieve/build the entries on
pageIds
Type: System.Collections.GenericIEnumerableString
List of page IDs to get entries for
isbackground
Type: SystemBoolean
If this is a background task
badEntryIds
Type: System.Collections.GenericListString
Pages to bypass during navigation entry retrieval
filterSchemaNames (Optional)
Type: System.Collections.GenericIEnumerableString
(Optional) List of schema names to filter the resulting page entries by. Any entries for pages that are not based on one of the provided schemas will be excluded from the results.
filterAncestorPageIds (Optional)
Type: System.Collections.GenericIEnumerableString
(Optional) List of ancestor page IDs to filter the resulting page entries by. Any entries for pages that are not under one of the provided ancestors will be excluded from the results.
useCheckedOut (Optional)
Type: SystemBoolean
Whether to included checked out pages, default is false
skipBuildingExistingEntries (Optional)
Type: SystemBoolean
Whether to skip the representative building step for pages with navigation representatives that are already built

Return Value

Type: IEnumerableICMSNavEntry
List of page navigation entries
See Also