Click or drag to resize

ICMSNavigationBuilder Interface

The navigation builder, used to create and manage navigation representatives for pages, components, and assets. Also in charge of providing navigation representatives to the content expansions engine.

Namespace:  Ingeniux.Runtime.NavigationBuilder
Assembly:  IGXRuntimeAPI (in IGXRuntimeAPI.dll) Version: 10.6.308
Syntax
public interface ICMSNavigationBuilder

The ICMSNavigationBuilder type exposes the following members.

Properties
  NameDescription
Public propertyCount
Gets the count of built navigation representatives.
Public propertyCurrentPublishingTarget
Gets the current publishing target for MFO publishing mode only.
Public propertyMFOPublishMode
Gets if MFO publishing mode is enabled. When MFO publishing mode is enabled, navigation building uses full URLs even at design time.
Top
Methods
  NameDescription
Public methodBuildAssetEntries
Build navigation representatives for the given asset IDs.
Public methodBuildPageEntries
Build navigation representatives for the given page IDs.
Public methodClear
Empty the navigation entry dictionary.
Public methodFlush
Serialize the navigation entry dictionary to disk.
Public methodGetAssetEntries
Gets the navigation representatives for the given asset IDs. It will build the representatives first, in case an entry does not exist or expired.
Public methodGetPageEntries
Gets the navigation representatives for the given page IDs. It will build the representatives first, in case an entry does not exist or expired.
Public methodPrepareBuilder
Prepare builder for navigation building. Needs to be called before navigation building to ensure that navigation building is based on a navigation building session.
Public methodReload
Load navigation entry dictionary from disk.
Top
Remarks
It will automatically start building navigation entries in the background as soon as it is constructed.
See Also