Skip to main content
Browse Documentation

Node

Created by Scott Yearsley, last modified by Mike Andrews on 11 Dec 2019

A Node represents a location within the navigational structure of a website. The linking of nodes as parent-child relationships forms the hierarchical structure of a website, with a node having a single parent and (optionally) multiple child nodes. A single entry can optionally be assigned to a node.

Properties

Name Type Description
Id GUID The node identifier
ProjectId string The API identifer of the project the node belongs to
DisplayName string The node display name
Path string The node path, e.g. "/movies/action/taken"
ParentId GUID? The parent node identifier. If the node is the root node then it will be null
Language string The language the node represents
EntryId GUID? The optionally assigned entry identifier
ChildCount int The count of child nodes
IsCanonical bool A flag to indicate whether the node is the canonical
Version NodeVersionInfo The node version information
IncludeInMenu bool A flag that determines whether the node should be included in menus

Methods

Method Returns Description
Children(IList entryFields = null, entryLinkDepth = 0) IReadOnlyList<Node> Gets a readonly list of the child nodes
ChildrenAsync(IList entryFields = null, entryLinkDepth = 0) IReadOnlyList<Node> Gets a readonly list of the child nodes asynchronously
Parent(IList entryFields = null, entryLinkDepth = 0) Node Get the parent node. If the node is the root node then it will be null
ParentAsync(IList entryFields = null, entryLinkDepth = 0) Node Gets the parent node asynchronously. If the node is the root node then it will be null
AncestorAtLevel(int level, IList entryFields = null, entryLinkDepth = 0) Node Gets an ancestor node at the specified level
AncestorAtLevelAsync(int level, IList entryFields = null, entryLinkDepth = 0) Node Gets an ancestor node at the specified level asynchronously
Ancestors(int startLevel, IList entryFields = null, entryLinkDepth = 0) IReadonlyList<Node> Gets a list of ancestor nodes
AncestorsAsync(int startLevel, IList entryFields = null, entryLinkDepth = 0) IReadonlyList<Node> Gets a list of ancestor nodes asynchronously
Siblings(IList entryFields = null, entryLinkDepth = 0) IReadonlyList<Node> Gets a list of sibling nodes including the current node
SiblingsAsync(IList entryFields = null, entryLinkDepth = 0) IReadonlyList<Node> Gets a list of sibling nodes including the current node
Entry() Entry Gets the associated entry instance assigned to the node.
EntryAsync() Entry Gets the associated entry instance assigned to the node asynchronously.
Entry<T> TypedModel of T Gets the entry as a typed model
EntryAsync<TModel> TypedModel of T Gets the entry as a typed model asynchronously