Show TOC

Background documentationNavigationCollection Locate this document in the navigation structure

 

A collection of links of a specific type, for example, favorite or dynamic navigation links. The links can be part of a navigation node or part of an entire navigation tree.

Fields

Name

Type

Description

type

String

The type of links contained in the collection.

See CollectionMapEntry for a list of collection types.

title

String

The display name for the link collection.

links

NavigationLink[]

An array of links.

collections

NavigationCollection[]

A nested array of link collections.

additionalAttributes

KeyValueEntry[]

An array of additional attributes for this navigation collection, as specified in the collectionAdditionalParams field of the NavigationTreeRequest or SelectedPathTreeRequest data types.