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

Package-level declarations

Types

data class Accessibility(val conformsTo: Set<Accessibility.Profile> = emptySet(), val certification: Accessibility.Certification? = null, val summary: String? = null, val accessModes: Set<Accessibility.AccessMode> = emptySet(), val accessModesSufficient: Set<Set<Accessibility.PrimaryAccessMode>> = emptySet(), val features: Set<Accessibility.Feature> = emptySet(), val hazards: Set<Accessibility.Hazard> = emptySet(), val exemptions: Set<Accessibility.Exemption> = emptySet()) : JSONable, Parcelable

Holds the accessibility metadata of a Publication.

Collection

typealias Collection = Contributor

Collection type used for collection/series metadata. For convenience, the JSON schema reuse the Contributor's definition.

Contributor

data class Contributor(val localizedName: LocalizedString, val localizedSortAs: LocalizedString? = null, val identifier: String? = null, val roles: Set<String> = emptySet(), val position: Double? = null, val links: List<Link> = emptyList()) : JSONable, Parcelable

Contributor Object for the Readium Web Publication Manifest. https://readium.org/webpub-manifest/schema/contributor-object.schema.json

Href

class Href : Parcelable

An hypertext reference points to a resource in a Publication.

Link

data class Link(val href: Href, val mediaType: MediaType? = null, val title: String? = null, val rels: Set<String> = setOf(), val properties: Properties = Properties(), val height: Int? = null, val width: Int? = null, val bitrate: Double? = null, val duration: Double? = null, val languages: List<String> = listOf(), val alternates: List<Link> = listOf(), val children: List<Link> = listOf()) : JSONable, Parcelable

Link Object for the Readium Web Publication Manifest. https://readium.org/webpub-manifest/schema/link.schema.json

LocalizedString

data class LocalizedString(val translations: Map<String?, LocalizedString.Translation> = emptyMap()) : JSONable, Parcelable

Represents a string with multiple translations indexed by a BCP 47 language tag.

Locator

data class Locator(val href: Url, val mediaType: MediaType, val title: String? = null, val locations: Locator.Locations = Locations(), val text: Locator.Text = Text()) : JSONable, Parcelable

Represents a precise location in a publication in a format that can be stored and shared.

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.

Manifest

data class Manifest(val context: List<String> = emptyList(), val metadata: Metadata, val links: List<Link> = emptyList(), val readingOrder: List<Link> = emptyList(), val resources: List<Link> = emptyList(), val tableOfContents: List<Link> = emptyList(), val subcollections: Map<String, List<PublicationCollection>> = emptyMap()) : JSONable

Holds the metadata of a Readium publication, as described in the Readium Web Publication Manifest.

ManifestTransformer

interface ManifestTransformer

Transforms a manifest's components.

Metadata

data class Metadata(val identifier: String? = null, val type: String? = null, val conformsTo: Set<Publication.Profile> = emptySet(), val localizedTitle: LocalizedString? = null, val localizedSubtitle: LocalizedString? = null, val localizedSortAs: LocalizedString? = null, val modified: Instant? = null, val published: Instant? = null, val accessibility: Accessibility? = null, val languages: List<String> = emptyList(), val subjects: List<Subject> = emptyList(), val authors: List<Contributor> = emptyList(), val translators: List<Contributor> = emptyList(), val editors: List<Contributor> = emptyList(), val artists: List<Contributor> = emptyList(), val illustrators: List<Contributor> = emptyList(), val letterers: List<Contributor> = emptyList(), val pencilers: List<Contributor> = emptyList(), val colorists: List<Contributor> = emptyList(), val inkers: List<Contributor> = emptyList(), val narrators: List<Contributor> = emptyList(), val contributors: List<Contributor> = emptyList(), val publishers: List<Contributor> = emptyList(), val imprints: List<Contributor> = emptyList(), val readingProgression: ReadingProgression? = null, val description: String? = null, val duration: Double? = null, val numberOfPages: Int? = null, val belongsTo: Map<String, List<Collection>> = emptyMap(), val tdm: Tdm? = null, val otherMetadata: Map<String, Any> = mapOf()) : JSONable, Parcelable

https://readium.org/webpub-manifest/schema/metadata.schema.json

Properties

data class Properties(val otherProperties: Map<String, Any> = emptyMap()) : JSONable, Parcelable

Properties associated to the linked resource.

Publication

class Publication(val manifest: Manifest, val container: Container<Resource> = EmptyContainer(), servicesBuilder: Publication.ServicesBuilder = ServicesBuilder()) : PublicationServicesHolder

The Publication shared model is the entry-point for all the metadata and services related to a Readium publication.

PublicationCollection

data class PublicationCollection(val metadata: Map<String, Any> = emptyMap(), val links: List<Link> = emptyList(), val subcollections: Map<String, List<PublicationCollection>> = emptyMap()) : JSONable, Parcelable

Core Collection Model

PublicationId

typealias PublicationId = String

A reference uniquely identifying a publication in the reading app.

PublicationServicesHolder

interface PublicationServicesHolder : Closeable

Holds Publication.Service instances for a Publication.

ReadingProgression

@Serializable

enum ReadingProgression : Parcelable, Enum<ReadingProgression>

Subject

data class Subject(val localizedName: LocalizedString, val localizedSortAs: LocalizedString? = null, val scheme: String? = null, val code: String? = null, val links: List<Link> = emptyList()) : JSONable, Parcelable

https://github.com/readium/webpub-manifest/tree/master/contexts/default#subjects

Tdm

data class Tdm(val reservation: Tdm.Reservation, val policy: AbsoluteUrl? = null) : JSONable, Parcelable

Publications can indicate whether they allow third parties to use their content for text and data mining purposes using the TDM Rep protocol, as defined in a W3C Community Group Report.