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
)
Function SerializeAssetNavigation (
depth As Integer,
includeAssets As Boolean,
env As ICMSEnvironment,
navBuildSession As ICMSNavigationBuildingSession,
isBackground As Boolean,
Optional filterSchemaNames As IEnumerable(Of String) = Nothing,
Optional filterFolders As IEnumerable(Of String) = Nothing,
Optional includeSelf As Boolean = true,
Optional originEleID As String = "",
Optional useCheckedOut As Boolean = false,
Optional builtEntries As Dictionary(Of String, ICMSAssetEntry) = Nothing
) As XElement
XElement^ SerializeAssetNavigation(
int depth,
bool includeAssets,
ICMSEnvironment^ env,
ICMSNavigationBuildingSession^ navBuildSession,
bool isBackground,
IEnumerable<String^>^ filterSchemaNames = nullptr,
IEnumerable<String^>^ filterFolders = nullptr,
bool includeSelf = true,
String^ originEleID = L"",
bool useCheckedOut = false,
Dictionary<String^, ICMSAssetEntry^>^ builtEntries = nullptr
)
abstract SerializeAssetNavigation :
depth : int *
includeAssets : bool *
env : ICMSEnvironment *
navBuildSession : ICMSNavigationBuildingSession *
isBackground : bool *
?filterSchemaNames : IEnumerable<string> *
?filterFolders : IEnumerable<string> *
?includeSelf : bool *
?originEleID : string *
?useCheckedOut : bool *
?builtEntries : Dictionary<string, ICMSAssetEntry>
(* Defaults:
let _filterSchemaNames = defaultArg filterSchemaNames null
let _filterFolders = defaultArg filterFolders null
let _includeSelf = defaultArg includeSelf true
let _originEleID = defaultArg originEleID ""
let _useCheckedOut = defaultArg useCheckedOut false
let _builtEntries = defaultArg builtEntries null
*)
-> XElement
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:
XElementAn XML navigation structure
See Also