readium-shared/org.readium.r2.shared.opds

Package-level declarations

Types

data class Acquisition(val type: String, val children: List<Acquisition> = emptyList()) : JSONable, Parcelable

OPDS Acquisition Object.

data class Availability(val state: Availability.State, val since: Instant? = null, val until: Instant? = null) : JSONable, Parcelable

Indicated the availability of a given resource.

Copies

data class Copies(val total: Int? = null, val available: Int? = null) : JSONable, Parcelable

Library-specific feature that contains information about the copies that a library has acquired.

Facet

data class Facet(val title: String, val metadata: OpdsMetadata = OpdsMetadata(title = title), val links: List<Link> = emptyList())

Feed

data class Feed(val title: String, val type: Int, val href: Url, val metadata: OpdsMetadata = OpdsMetadata(title = title), val links: List<Link> = emptyList(), val facets: List<Facet> = emptyList(), val groups: List<Group> = emptyList(), val publications: List<Publication> = emptyList(), val navigation: List<Link> = emptyList(), val context: List<String> = emptyList())

Group

data class Group(val title: String, val metadata: OpdsMetadata = OpdsMetadata(title = title), val links: List<Link> = emptyList(), val publications: List<Publication> = emptyList(), val navigation: List<Link> = emptyList())

Holds

data class Holds(val total: Int? = null, val position: Int? = null) : JSONable, Parcelable

Library-specific features when a specific book is unavailable but provides a hold list.

OpdsMetadata

data class OpdsMetadata(val title: String, val numberOfItems: Int? = null, val itemsPerPage: Int? = null, val currentPage: Int? = null, val modified: Instant? = null, val position: Int? = null, val rdfType: String? = null)

ParseData

data class ParseData(val feed: Feed?, val publication: Publication?, val type: Int)

Price

data class Price(val currency: String, val value: Double) : JSONable, Parcelable

The price of a publication in an OPDS link.