Click or drag to resize

ICMSNavigationBuilderGetAssetEntries Method

Gets the navigation representatives for the given asset 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<ICMSAssetEntry> GetAssetEntries(
	ICMSNavigationBuildingSession session,
	IEnumerable<string> assetIds,
	bool isbackground,
	List<string> badEntryIds,
	IEnumerable<string> filterSchemaNames = null,
	IEnumerable<string> filterAncestorIds = null,
	bool useCheckedOut = false,
	bool skipBuildingExistingEntries = false
)

Parameters

session
Type: Ingeniux.Runtime.NavigationBuilderICMSNavigationBuildingSession
Navigation building session to retrieve/build the entries on
assetIds
Type: System.Collections.GenericIEnumerableString
List of asset 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 asset entries by. Any entries for assets that are not based on one of the provided schemas will be excluded from the results.
filterAncestorIds (Optional)
Type: System.Collections.GenericIEnumerableString
(Optional) List of ancestor asset/folder IDs to filter the resulting asset entries by. Any entries for assets that are not under one of the provided ancestors will be excluded from the results.
useCheckedOut (Optional)
Type: SystemBoolean
Whether to included checked out assets, 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: IEnumerableICMSAssetEntry
List of asset navigation entries
See Also