Enables scripted content fragments to render custom navigation data.
Methods
Deserialize
Deserializes serialized custom navigation
Usage
#set($iListResponse = $core_v2_customNavigation.Deserialize($serializedCustomNavigation))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
serializedCustomNavigation | string | Serialized Custom Navigation | Required |
Return Type
IList<CustomNavigationItem>
Deserialize
Deserializes serialized custom navigation
Usage
#set($iListResponse = $core_v2_customNavigation.Deserialize($groupId, $serializedCustomNavigation))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
groupId | int | Group Id | Required | ||
serializedCustomNavigation | string | Serialized Custom Navigation | Required |
Return Type
IList<CustomNavigationItem>
Deserialize
Deserializes serialized custom navigation
Usage
#set($iListResponse = $core_v2_customNavigation.Deserialize($serializedCustomNavigation, "%{GroupId = $groupIdArg, Type = $typeArg, UserId = $userIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
serializedCustomNavigation | string | The serialized naivigation item(s) data | Required | ||
GroupId | int | The group identifier if retrieving group navigation items | Optional | ||
Type | string | The type of the navigation item to deserialize | Optional | group, site, user | |
UserId | int | The user identifier if retrieving user navigation items | Optional |
Return Type
IList<CustomNavigationItem>
Deserialize
Deserializes a serialized custom navigation item
Usage
#set($customNavigationItemResponse = $core_v2_customNavigation.Deserialize($serializedCustomNavigation, $uniqueId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
serializedCustomNavigation | string | Serialized Custom Navigation | Required | ||
uniqueId | string | Unique Id | Required |
Return Type
CustomNavigationItem
Deserialize
Deserializes a serialized custom navigation item
Usage
#set($customNavigationItemResponse = $core_v2_customNavigation.Deserialize($groupId, $serializedCustomNavigation, $uniqueId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
groupId | int | Group Id | Required | ||
serializedCustomNavigation | string | Serialized Custom Navigation | Required | ||
uniqueId | string | Unique Id | Required |
Return Type
CustomNavigationItem
Deserialize
Deserializes a serialized custom navigation item
Usage
#set($customNavigationItemResponse = $core_v2_customNavigation.Deserialize($serializedCustomNavigation, $uniqueId, "%{GroupId = $groupIdArg, Type = $typeArg, UserId = $userIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
serializedCustomNavigation | string | The serialized naivigation item(s) data | Required | ||
uniqueId | string | The ID of the navigation item to retrieve from the serialized data. | Required | ||
GroupId | int | The group identifier if retrieving group navigation items | Optional | ||
Type | string | The type of the navigation item to deserialize | Optional | group, site, user | |
UserId | int | The user identifier if retrieving group navigation items | Optional |
Return Type
CustomNavigationItem
FromWidget
Usage
#set($iListResponse = $core_v2_customNavigation.FromWidget($instanceIdentifier, $propertyName, "%{GroupId = $groupIdArg, Url = $urlArg, UserId = $userIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
instanceIdentifier | Guid | The instance identifier of the widget from which navigation items should be retrieved | Required | ||
propertyName | string | The property value within the widget containing navigation configuration | Required | ||
GroupId | int | The group identifier if retrieving group navigation items | Optional | ||
Url | string | The current URL | Optional | ||
UserId | int | The user identifier if retrieving user navigation items | Optional |
Return Type
IList<CustomNavigationItem>
Refresh
Clear the Navigation cache
Usage
$core_v2_customNavigation.Refresh()