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

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

Parameters

tdm

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.

otherMetadata

Additional metadata for extensions, as a JSON dictionary.

Constructors

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

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

Types

object Companion

Properties

val accessibility: Accessibility?

val artists: List<Contributor>

val authors: List<Contributor>

val belongsTo: Map<String, List<Collection>>

belongsToCollections

val belongsToCollections: List<Collection>

belongsToSeries

val belongsToSeries: List<Collection>

val colorists: List<Contributor>

val conformsTo: Set<Publication.Profile>

val contributors: List<Contributor>

val description: String?

val duration: Double?

val editors: List<Contributor>

val identifier: String?

val illustrators: List<Contributor>

val imprints: List<Contributor>

val inkers: List<Contributor>

val language: Language?

Returns the Language resolved from the declared BCP 47 primary language.

val languages: List<String>

val letterers: List<Contributor>

localizedSortAs

val localizedSortAs: LocalizedString?

localizedSubtitle

val localizedSubtitle: LocalizedString?

val localizedTitle: LocalizedString?

val modified: Instant?

val narrators: List<Contributor>

val numberOfPages: Int?

val otherMetadata: Map<String, Any>

val pencilers: List<Contributor>

val Metadata.presentation: Presentation

val published: Instant?

val publishers: List<Contributor>

readingProgression

val readingProgression: ReadingProgression?

val sortAs: String?

Returns the default translation string for the localizedSortAs.

val subjects: List<Subject>

val tdm: Tdm?

val title: String?

Returns the default translation string for the localizedTitle.

val translators: List<Contributor>

val type: String?

Functions

fun Metadata.copy(transformer: ManifestTransformer): Metadata

describeContents

abstract fun describeContents(): Int

operator fun get(key: String): Any?

Syntactic sugar to access the otherMetadata values by subscripting Metadata directly. metadata["layout"] == metadata.otherMetadata["layout"]

open override fun toJSON(): JSONObject

Serializes a Metadata to its RWPM JSON representation.

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