colibrio-reader-framework/com.colibrio.readingsystem.base/FetchNavigationItemReferencesOptions

FetchNavigationItemReferencesOptions

data class FetchNavigationItemReferencesOptions(val collectionTypes: List<NavigationCollectionType>? = null, val greedy: Boolean = false)

Options for fetching navigation item references from a ContentLocation.

Constructors

Link copied to clipboard
fun FetchNavigationItemReferencesOptions(collectionTypes: List<NavigationCollectionType>? = null, greedy: Boolean = false)

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
fun serialize(generator: JsonGenerator)

Properties

Link copied to clipboard
val collectionTypes: List<NavigationCollectionType>? = null

What navigation collection types to fetch references for. If not specified, all navigation collection types are assumed.

Link copied to clipboard
val greedy: Boolean = false

If true, extra navigation item references before the locator may be included in the "itemsInRange" list in order to make sure that all content targeted by the locator are mapped to a corresponding navigation item.