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

PublicationServicesHolder

interface PublicationServicesHolder : Closeable

Holds Publication.Service instances for a Publication.

Inheritors

Properties

val PublicationServicesHolder.cacheService: CacheService?

Functions

abstract fun close()

Closes this object and releases any resources associated with it. If the object is already closed then invoking this method has no effect.

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

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

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

Returns all the publication services that are instances of serviceType.

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.