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

ReaderPublicationNavigationItemReferenceData

data class ReaderPublicationNavigationItemReferenceData(val collectionIndex: Int, val collectionType: NavigationCollectionType, val navigationItemId: Int, val readerDocumentIndexInSpine: Int, val readerPublicationDefaultLocatorUrl: String)

Describes a reference to an item in the publication navigation.

Constructors

ReaderPublicationNavigationItemReferenceData

fun ReaderPublicationNavigationItemReferenceData(collectionIndex: Int, collectionType: NavigationCollectionType, navigationItemId: Int, readerDocumentIndexInSpine: Int, readerPublicationDefaultLocatorUrl: String)

Types

object Companion

Functions

fun serialize(generator: JsonGenerator)

Properties

collectionIndex

val collectionIndex: Int

The index of the collection within the publication navigation collections list.

val collectionType: NavigationCollectionType

The type of navigation collection.

navigationItemId

val navigationItemId: Int

The id of the ReaderPublicationNavigationItem referenced.

readerDocumentIndexInSpine

val readerDocumentIndexInSpine: Int

The index in the related ReaderPublication's spine of the document that the navigation item references.

readerPublicationDefaultLocatorUrl

val readerPublicationDefaultLocatorUrl: String

The base URL used when creating Locators pointing to content in the related publication.