readium-shared/org.readium.r2.shared.publication/LocatorCollection

LocatorCollection

data class LocatorCollection(val metadata: LocatorCollection.Metadata = Metadata(), val links: List<Link> = emptyList(), val locators: List<Locator> = emptyList()) : JSONable, Parcelable

Represents a sequential list of Locator objects.

For example, a search result or a list of positions.

Constructors

LocatorCollection

constructor(metadata: LocatorCollection.Metadata = Metadata(), links: List<Link> = emptyList(), locators: List<Locator> = emptyList())

Types

object Companion

data class Metadata(val localizedTitle: LocalizedString? = null, val numberOfItems: Int? = null, val otherMetadata: Map<String, Any> = mapOf()) : JSONable, Parcelable

Holds the metadata of a LocatorCollection.

Properties

val links: List<Link>

val locators: List<Locator>

val metadata: LocatorCollection.Metadata

Functions

describeContents

abstract fun describeContents(): Int

open override fun toJSON(): JSONObject

Serializes the object to its JSON representation.

abstract fun writeToParcel(p0: Parcel, p1: Int)