Interface IFetchNavigationItemReferencesResult

The result object for ContentLocation.fetchNavigationItemReferences()

interface IFetchNavigationItemReferencesResult {
    getItemsAfter(): IReaderPublicationNavigationItemReference[];
    getItemsBefore(): IReaderPublicationNavigationItemReference[];
    getItemsInRange(): IReaderPublicationNavigationItemReference[];
    toJSON(): IFetchNavigationItemReferencesResultData;
}

Methods

getItemsAfter

getItemsAfter(): IReaderPublicationNavigationItemReference[]
The nearest navigation item for each collection type after the locator.

Returns IReaderPublicationNavigationItemReference[]

getItemsBefore

getItemsBefore(): IReaderPublicationNavigationItemReference[]
The nearest navigation item for each collection type before the locator.

Returns IReaderPublicationNavigationItemReference[]

getItemsInRange

getItemsInRange(): IReaderPublicationNavigationItemReference[]
All navigation items within the locator range.

Note This API is still in Beta. In cases where content location is a range you may only get the first IReaderPublicationNavigationItemReference, even though there are multiple intersecting items in visible range. As an interim solution you can use this method together with the getItemsAfter() and the IContentLocation.intersects() method to find navigation items within the visible range.

Returns IReaderPublicationNavigationItemReference[]

toJSON

toJSON(): IFetchNavigationItemReferencesResultData
Get this object as a plain JSON object.

Returns IFetchNavigationItemReferencesResultData