ICMSNavigationBuilderGetPageEntries Method
|
Gets the navigation representatives for the given page IDs.
It will build the representatives first, in case an entry does not exist or expired.
Namespace:
Ingeniux.Runtime.NavigationBuilder
Assembly:
IGXRuntimeAPI (in IGXRuntimeAPI.dll) Version: 10.6.308
Syntax IEnumerable<ICMSNavEntry> GetPageEntries(
ICMSNavigationBuildingSession session,
IEnumerable<string> pageIds,
bool isbackground,
List<string> badEntryIds,
IEnumerable<string> filterSchemaNames = null,
IEnumerable<string> filterAncestorPageIds = null,
bool useCheckedOut = false,
bool skipBuildingExistingEntries = false
)
Function GetPageEntries (
session As ICMSNavigationBuildingSession,
pageIds As IEnumerable(Of String),
isbackground As Boolean,
badEntryIds As List(Of String),
Optional filterSchemaNames As IEnumerable(Of String) = Nothing,
Optional filterAncestorPageIds As IEnumerable(Of String) = Nothing,
Optional useCheckedOut As Boolean = false,
Optional skipBuildingExistingEntries As Boolean = false
) As IEnumerable(Of ICMSNavEntry)
IEnumerable<ICMSNavEntry^>^ GetPageEntries(
ICMSNavigationBuildingSession^ session,
IEnumerable<String^>^ pageIds,
bool isbackground,
List<String^>^ badEntryIds,
IEnumerable<String^>^ filterSchemaNames = nullptr,
IEnumerable<String^>^ filterAncestorPageIds = nullptr,
bool useCheckedOut = false,
bool skipBuildingExistingEntries = false
)
abstract GetPageEntries :
session : ICMSNavigationBuildingSession *
pageIds : IEnumerable<string> *
isbackground : bool *
badEntryIds : List<string> *
?filterSchemaNames : IEnumerable<string> *
?filterAncestorPageIds : IEnumerable<string> *
?useCheckedOut : bool *
?skipBuildingExistingEntries : bool
(* Defaults:
let _filterSchemaNames = defaultArg filterSchemaNames null
let _filterAncestorPageIds = defaultArg filterAncestorPageIds null
let _useCheckedOut = defaultArg useCheckedOut false
let _skipBuildingExistingEntries = defaultArg skipBuildingExistingEntries false
*)
-> IEnumerable<ICMSNavEntry>
Parameters
- session
- Type: Ingeniux.Runtime.NavigationBuilderICMSNavigationBuildingSession
Navigation building session to retrieve/build the entries on - pageIds
- Type: System.Collections.GenericIEnumerableString
List of page IDs to get entries for - isbackground
- Type: SystemBoolean
If this is a background task - badEntryIds
- Type: System.Collections.GenericListString
Pages to bypass during navigation entry retrieval - filterSchemaNames (Optional)
- Type: System.Collections.GenericIEnumerableString
(Optional) List of schema names to filter the resulting page entries by.
Any entries for pages that are not based on one of the provided schemas will be excluded from the results. - filterAncestorPageIds (Optional)
- Type: System.Collections.GenericIEnumerableString
(Optional) List of ancestor page IDs to filter the resulting page entries by.
Any entries for pages that are not under one of the provided ancestors will be excluded from the results. - useCheckedOut (Optional)
- Type: SystemBoolean
Whether to included checked out pages, default is false - skipBuildingExistingEntries (Optional)
- Type: SystemBoolean
Whether to skip the representative building step for pages with navigation representatives that are already built
Return Value
Type:
IEnumerableICMSNavEntryList of page navigation entries
See Also