Enables scripted content fragments to render custom navigation data.
Methods
Deserialize
Deserialize Overload 1
Deserializes serialized custom navigation
Velocity
#set($iListResponse = $core_v2_customNavigation.Deserialize($serializedCustomNavigation))
JavaScript
var iListResponse = core_v2_customNavigation.Deserialize(serializedCustomNavigation);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
serializedCustomNavigation | String | Serialized Custom Navigation | Required |
Deserialize Overload 2
Deserializes serialized custom navigation
Velocity
#set($iListResponse = $core_v2_customNavigation.Deserialize($groupId, $serializedCustomNavigation))
JavaScript
var iListResponse = core_v2_customNavigation.Deserialize(groupId, serializedCustomNavigation);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
groupId | Int32 | Group Id | Required | ||
serializedCustomNavigation | String | Serialized Custom Navigation | Required |
Deserialize Overload 3
Deserializes serialized custom navigation
Velocity
#set($iListResponse = $core_v2_customNavigation.Deserialize($serializedCustomNavigation, "%{ GroupId = $groupIdArg, Type = $typeArg, UserId = $userIdArg }"))
JavaScript
var 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 | ||
options | Options | Set of optional parameters including: | Required | ||
GroupId | Int32 | The group identifier if retrieving group navigation items | Optional | ||
Type | String | The type of the navigation item to deserialize | Optional | group, site, user | |
UserId | Int32 | The user identifier if retrieving user navigation items | Optional |
Deserialize Overload 4
Deserializes a serialized custom navigation item
Velocity
#set($iListResponse = $core_v2_customNavigation.Deserialize($serializedCustomNavigation, $uniqueId))
JavaScript
var iListResponse = core_v2_customNavigation.Deserialize(serializedCustomNavigation, uniqueId);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
serializedCustomNavigation | String | Serialized Custom Navigation | Required | ||
uniqueId | String | Unique Id | Required |
Deserialize Overload 5
Deserializes a serialized custom navigation item
Velocity
#set($iListResponse = $core_v2_customNavigation.Deserialize($groupId, $serializedCustomNavigation, $uniqueId))
JavaScript
var iListResponse = core_v2_customNavigation.Deserialize(groupId, serializedCustomNavigation, uniqueId);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
groupId | Int32 | Group Id | Required | ||
serializedCustomNavigation | String | Serialized Custom Navigation | Required | ||
uniqueId | String | Unique Id | Required |
Deserialize Overload 6
Deserializes a serialized custom navigation item
Velocity
#set($iListResponse = $core_v2_customNavigation.Deserialize($serializedCustomNavigation, $uniqueId, "%{ GroupId = $groupIdArg, Type = $typeArg, UserId = $userIdArg }"))
JavaScript
var iListResponse = 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 | ||
options | Options | Set of optional parameters including: | Required | ||
GroupId | Int32 | The group identifier if retrieving group navigation items | Optional | ||
Type | String | The type of the navigation item to deserialize | Optional | group, site, user | |
UserId | Int32 | The user identifier if retrieving group navigation items | Optional |
Returns
IList of CustomNavigationItem
FromWidget
Velocity
#set($iListResponse = $core_v2_customNavigation.FromWidget($instanceIdentifier, $propertyName, "%{ GroupId = $groupIdArg, Url = $urlArg, UserId = $userIdArg }"))
JavaScript
var 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 | ||
options | Options | Set of optional parameters including: | Required | ||
GroupId | Int32 | The group identifier if retrieving group navigation items | Optional | ||
Url | String | The current URL | Optional | ||
UserId | Int32 | The user identifier if retrieving user navigation items | Optional |
Returns
IList of CustomNavigationItem
Refresh
Clear the Navigation cache
Velocity
$core_v2_customNavigation.Refresh()
JavaScript
core_v2_customNavigation.Refresh();