Click or drag to resize

ICategoryDefinitionSerializeAssetNavigation Method

Gets the structure for asset taxonomy navigation, with a given depth.

Namespace:  Ingeniux.Runtime.Taxonomy
Assembly:  IGXRuntimeAPI (in IGXRuntimeAPI.dll) Version: 10.6.308
Syntax
XElement SerializeAssetNavigation(
	int depth,
	bool includeAssets,
	ICMSEnvironment env,
	ICMSNavigationBuildingSession navBuildSession,
	bool isBackground,
	IEnumerable<string> filterSchemaNames = null,
	IEnumerable<string> filterFolders = null,
	bool includeSelf = true,
	string originEleID = "",
	bool useCheckedOut = false,
	Dictionary<string, ICMSAssetEntry> builtEntries = null
)

Parameters

depth
Type: SystemInt32
How deep to list the category's descendants
includeAssets
Type: SystemBoolean
Whether to include assets in the navigation or not
env
Type: Ingeniux.RuntimeICMSEnvironment
The CMS Environment
navBuildSession
Type: Ingeniux.Runtime.NavigationBuilderICMSNavigationBuildingSession
The navigation session on which to build the navigation structure
isBackground
Type: SystemBoolean
Whether this is a background task
filterSchemaNames (Optional)
Type: System.Collections.GenericIEnumerableString
The optional list of schema names to filter included assets by. If provided, only assets based on one of these schemas will be included in the resulting navigation structure.
filterFolders (Optional)
Type: System.Collections.GenericIEnumerableString
The optional list of asset folder IDs to filter included assets by. If provided, only assets under one of these folders will be included in the resulting navigation structure.
includeSelf (Optional)
Type: SystemBoolean
Whether to include the current asset in the navigation structure
originEleID (Optional)
Type: SystemString
ID of the current asset
useCheckedOut (Optional)
Type: SystemBoolean
Whether or not ot use checked out assets. False by default.
builtEntries (Optional)
Type: System.Collections.GenericDictionaryString, ICMSAssetEntry
A list of prebuild asset entries in link node format to use to build this navigation. If omitted, a call to GetAssets will be made.

Return Value

Type: XElement
An XML navigation structure
See Also