ICMSNavigationBuildingSession Interface

Represents a session for managing navigation representative entries for pages and assets.

Namespace: Ingeniux.Runtime.NavigationBuilder
Assembly: IGXRuntimeAPI (in IGXRuntimeAPI.dll) Version: 10.6.308

Syntax

public interface ICMSNavigationBuildingSession : IDisposable

Public Interface ICMSNavigationBuildingSession
	Inherits IDisposable

public interface class ICMSNavigationBuildingSession : IDisposable

type ICMSNavigationBuildingSession =  
    interface
        interface IDisposable
    end

The ICMSNavigationBuildingSession type exposes the following members.

Properties

	Name	Description
	AssetsToBuild	Gets the list of asset IDs for asset navigation entries to build.
	Builder	Gets the builder for building page and asset navigation entries.
	EndTime	Gets the DateTime when the navigation building session was disposed.
	NeedsRebuild	Gets if the navigation entries need to be rebuilt.
	PagesToBuild	Gets the list of page IDs for page navigation entries to build.
	StartTime	Gets the DateTime when the navigation building session was created.
	UsingPhysicalCacheInAnyNavigation	Gets and sets if the navigation building session is using a physical cache. The default is false.

Methods

	Name	Description
	AddAssets	Adds the provided page IDs to the list of assets to create navigation entries for.
	AddPages	Adds the provided page IDs to the list of pages to create navigation entries for.

Remarks

Use this session to access the navigation builder for creating page and asset navigation entries.