Show TOC

NavigationTreeLocate this document in the navigation structure

Use

Represents a navigation tree for the currently authenticated user. The following is the structure of NavigationTree :

Fields

Name

Type

Description

rootNodes

NavigationNode[]

The top-level nodes of the tree.

To get subsequent levels, use the childNodes field of each NavigationNode object.

collections

NavigationCollection []

The link collections for the entire navigation tree.

Each navigation node can also have its own link collections.

lastModification

Date

The date and time the navigation tree was generated.

Use this field to determine if the navigation hierarchy was updated since the last time you requested the tree. If it is different from the lastModification field sent in the NavigationTreeRequest or SelectedPathTreeRequest object of the request, then the tree was updated.

upToDate

boolean

Indicates whether the tree is valid.

A value of false indicates an error.

cacheLifeTime

Date

The amount of time, in minutes, that the navigation tree is valid.

requestedNode

NavigationNode[]

The node specified in the request.