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

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.

Parameters

manifest

The manifest holding the publication metadata extracted from the publication file.

container

The underlying container used to read publication resources. The default implementation returns Resource.Exception.NotFound for all HREFs.

servicesBuilder

Holds the list of service factories used to create the instances of Publication.Service attached to this Publication.

Constructors

Publication

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

Types

Builder

class Builder(var manifest: Manifest, var container: Container<Resource>, var servicesBuilder: Publication.ServicesBuilder = ServicesBuilder())

Builds a Publication from its components.

Companion

object Companion

Profile

data class Profile(val uri: String) : Parcelable

Represents a Readium Web Publication Profile a Publication can conform to.

Service

interface Service : Closeable

Base interface to be implemented by all publication services.

ServicesBuilder

class ServicesBuilder

Builds a list of Publication.Service from a collection of service factories.

Properties

baseUrl

val baseUrl: Url?

The URL from which the publication resources are relative to, computed from the Link with self relation.

cacheService

val PublicationServicesHolder.cacheService: CacheService?

container

val container: Container<Resource>

context

val context: List<String>

credentials

val Publication.credentials: String?

Credentials used to unlock this Publication.

images

val Publication.images: List<Link>

isProtected

val Publication.isProtected: Boolean

Returns whether this Publication is protected by a Content Protection technology.

isRestricted

val Publication.isRestricted: Boolean

Whether the Publication has a restricted access to its resources, and can't be rendered in a Navigator.

isSearchable

val Publication.isSearchable: Boolean

Indicates whether the content of this publication can be searched.

landmarks

val Publication.landmarks: List<Link>

Identifies fundamental structural components of the publication in order to enable Reading Systems to provide the User efficient access to them.

links

val links: List<Link>

listOfAudioClips

val Publication.listOfAudioClips: List<Link>

listOfIllustrations

val Publication.listOfIllustrations: List<Link>

listOfTables

val Publication.listOfTables: List<Link>

listOfVideoClips

val Publication.listOfVideoClips: List<Link>

manifest

val manifest: Manifest

metadata

val metadata: Metadata

pageList

val Publication.pageList: List<Link>

Provides navigation to positions in the Publication content that correspond to the locations of page boundaries present in a print source being represented by this EPUB Publication.

protectionError

val Publication.protectionError: Error?

The error raised when trying to unlock the Publication, if any.

protectionName

val Publication.protectionName: String?

User-facing name for this Content Protection, e.g. "Readium LCP". It could be used in a sentence such as "Protected by {name}".

protectionScheme

val Publication.protectionScheme: ContentProtection.Scheme?

Known technology for this type of Content Protection.

readingOrder

val readingOrder: List<Link>

Identifies a list of resources in reading order for the publication.

resources

val resources: List<Link>

Identifies resources that are necessary for rendering the publication.

rights

val Publication.rights: ContentProtectionService.UserRights

Manages consumption of user rights and permissions.

searchOptions

val Publication.searchOptions: SearchService.Options

Default value for the search options of this publication.

subcollections

val subcollections: Map<String, List<PublicationCollection>>

tableOfContents

val tableOfContents: List<Link>

Identifies the collection that contains a table of contents.

Functions

open override fun close()

Closes any opened resource associated with the Publication, including services.

conformsTo

fun conformsTo(profile: Publication.Profile): Boolean

Returns whether this publication conforms to the given Readium Web Publication Profile.

content

fun Publication.content(start: Locator? = null): Content?

Creates a Content starting from the given start location, or the beginning of the publication when missing.

cover

suspend fun Publication.cover(): Bitmap?

Returns the publication cover as a Bitmap at its maximum size.

coverFitting

suspend fun Publication.coverFitting(maxSize: Size): Bitmap?

Returns the publication cover as a Bitmap, scaled down to fit the given maxSize.

findService

open override fun <T : Publication.Service> findService(serviceType: KClass<T>): T?

Returns the first publication service that is an instance of serviceType.

findServices

open override fun <T : Publication.Service> findServices(serviceType: KClass<T>): List<T>

Returns all the publication services that are instances of serviceType.

get

fun get(link: Link): Resource?

Returns the resource targeted by the given non-templated link.

fun get(href: Url): Resource?

Returns the resource targeted by the given href.

linksWithRel

fun linksWithRel(rel: String): List<Link>

Finds all Links having the given rel in the publications's links.

linkWithHref

fun linkWithHref(href: Url): Link?

Finds the first Link with the given HREF in the publication's links.

linkWithRel

fun linkWithRel(rel: String): Link?

Finds the first Link having the given rel in the publications's links.

locate

suspend fun Publication.locate(locator: Locator): Locator?

Locates the target of the given locator.

locateProgression

suspend fun Publication.locateProgression(totalProgression: Double): Locator?

Locates the target at the given progression relative to the whole publication.

locatorFromLink

fun locatorFromLink(link: Link): Locator?

Creates a new Locator object from a Link to a resource of this publication.

positions

suspend fun PublicationServicesHolder.positions(): List<Locator>

Returns the list of all the positions in the publication.

positionsByReadingOrder

suspend fun PublicationServicesHolder.positionsByReadingOrder(): List<List<Locator>>

Returns the list of all the positions in the publication, grouped by the resource reading order index.

suspend fun Publication.search(query: String, options: SearchService.Options? = null): SearchIterator?

Starts a new search through the publication content, with the given query.

url

fun url(locator: Locator): Url

Returns the URL to the resource represented by the given locator, relative to the publication's link with self relation.

fun url(href: Href, parameters: Map<String, String> = emptyMap()): Url

Returns the URL to the resource represented by the given href, relative to the publication's link with self relation.

fun url(link: Link, parameters: Map<String, String> = emptyMap()): Url

Returns the URL to the resource represented by the given link, relative to the publication's link with self relation.