Skip to content

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

Package-level declarations

Types

Name Summary
Clip [androidJvm]
data class Clip(val audioResource: String? = null, val fragmentId: String? = null, val start: Double? = null, val end: Double? = null)
Collection [androidJvm]
typealias Collection = org.readium.r2.shared.publication.Collection
Contributor [androidJvm]
typealias Contributor = org.readium.r2.shared.publication.Contributor
DelicateReadiumApi [androidJvm]
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.TYPEALIAS, AnnotationTarget.PROPERTY])
annotation class DelicateReadiumApi
DomRange [androidJvm]
typealias DomRange = org.readium.r2.shared.publication.html.DomRange
Encryption [androidJvm]
typealias Encryption = org.readium.r2.shared.publication.encryption.Encryption
Enumerable [androidJvm]
class ~~Enumerable~~(var index: Int, values: List<String>, var ref: String, var name: String) : UserProperty
ExperimentalReadiumApi [androidJvm]
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.TYPEALIAS, AnnotationTarget.PROPERTY])
annotation class ExperimentalReadiumApi
Incremental [androidJvm]
class ~~Incremental~~(var value: Float, val min: Float, val max: Float, step: Float, suffix: String, var ref: String, var name: String) : UserProperty
Injectable [androidJvm]
enum Injectable : Enum<Injectable> , Serializable
InternalReadiumApi [androidJvm]
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.TYPEALIAS, AnnotationTarget.PROPERTY, AnnotationTarget.CONSTRUCTOR])
annotation class InternalReadiumApi
JSONable [androidJvm]
interface JSONable
Link [androidJvm]
typealias Link = org.readium.r2.shared.publication.Link
Locations [androidJvm]
typealias Locations = Locator.Locations
Locator [androidJvm]
typealias Locator = org.readium.r2.shared.publication.Locator
LocatorText [androidJvm]
typealias LocatorText = Locator.Text
MediaOverlayNode [androidJvm]
data class MediaOverlayNode(val text: String, val audio: String?, val children: List<MediaOverlayNode> = listOf(), val role: List<String> = listOf()) : Serializable
MediaOverlays [androidJvm]
data class MediaOverlays(nodes: List<MediaOverlayNode> = listOf()) : Serializable
Metadata [androidJvm]
typealias Metadata = org.readium.r2.shared.publication.Metadata
MultilanguageString [androidJvm]
typealias MultilanguageString = LocalizedString
PageProgressionDirection [androidJvm]
typealias PageProgressionDirection = ReadingProgression
PdfSupport [androidJvm]
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.TYPEALIAS, AnnotationTarget.PROPERTY])
annotation class PdfSupport
Properties [androidJvm]
typealias Properties = org.readium.r2.shared.publication.Properties
Publication [androidJvm]
typealias Publication = org.readium.r2.shared.publication.Publication
Range [androidJvm]
typealias Range = DomRange.Point
ReadiumCSSName [androidJvm]
enum ~~ReadiumCSSName~~ : Enum<ReadiumCSSName>
Rendition [androidJvm]
typealias Rendition = Presentation
RenditionFlow [androidJvm]
typealias RenditionFlow = Presentation.Overflow
RenditionLayout [androidJvm]
typealias RenditionLayout = EpubLayout
RenditionOrientation [androidJvm]
typealias RenditionOrientation = Presentation.Orientation
RenditionSpread [androidJvm]
typealias RenditionSpread = Presentation.Spread
RootFile [androidJvm]
class RootFile
Search [androidJvm]
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.TYPEALIAS, AnnotationTarget.PROPERTY])
annotation class Search
Subject [androidJvm]
typealias Subject = org.readium.r2.shared.publication.Subject
Switchable [androidJvm]
class ~~Switchable~~(onValue: String, offValue: String, var on: Boolean, var ref: String, var name: String) : UserProperty
UserException [androidJvm]
open class UserException : Exception
An exception that can be presented to the user using a localized message.
UserProperties [androidJvm]
class ~~UserProperties~~ : Serializable
UserProperty [androidJvm]
sealed class ~~UserProperty~~

Functions

Name Summary
normalize [androidJvm]
fun ~~normalize~~(base: String, href: String?): String
parseLink [androidJvm]
fun ~~parseLink~~(linkDict: JSONObject, feedUrl: URL? = null): Link
parsePublication [androidJvm]
fun ~~parsePublication~~(pubDict: JSONObject): Publication
promise [androidJvm]
fun Request.~~promise~~(): Promise<Triple<Request, Response, ByteArray>, Exception>
removeLastComponent [androidJvm]
fun URL.~~removeLastComponent~~(): URL
toJSON [androidJvm]
fun List<JSONable>.toJSON(): JSONArray
Serializes a list of JSONable into a JSONArray.

Properties

Name Summary
APPEARANCE_NAME [androidJvm]
const val ~~APPEARANCE_NAME~~: String
APPEARANCE_REF [androidJvm]
const val ~~APPEARANCE_REF~~: String
COLUMN_COUNT_NAME [androidJvm]
const val ~~COLUMN_COUNT_NAME~~: String
COLUMN_COUNT_REF [androidJvm]
const val ~~COLUMN_COUNT_REF~~: String
FONT_FAMILY_NAME [androidJvm]
const val ~~FONT_FAMILY_NAME~~: String
FONT_FAMILY_REF [androidJvm]
const val ~~FONT_FAMILY_REF~~: String
FONT_OVERRIDE_NAME [androidJvm]
const val ~~FONT_OVERRIDE_NAME~~: String
FONT_OVERRIDE_REF [androidJvm]
const val ~~FONT_OVERRIDE_REF~~: String
FONT_SIZE_NAME [androidJvm]
const val ~~FONT_SIZE_NAME~~: String
FONT_SIZE_REF [androidJvm]
const val ~~FONT_SIZE_REF~~: String
LETTER_SPACING_NAME [androidJvm]
const val ~~LETTER_SPACING_NAME~~: String
LETTER_SPACING_REF [androidJvm]
const val ~~LETTER_SPACING_REF~~: String
LINE_HEIGHT_NAME [androidJvm]
const val ~~LINE_HEIGHT_NAME~~: String
LINE_HEIGHT_REF [androidJvm]
const val ~~LINE_HEIGHT_REF~~: String
PAGE_MARGINS_NAME [androidJvm]
const val ~~PAGE_MARGINS_NAME~~: String
PAGE_MARGINS_REF [androidJvm]
const val ~~PAGE_MARGINS_REF~~: String
PUBLISHER_DEFAULT_NAME [androidJvm]
const val ~~PUBLISHER_DEFAULT_NAME~~: String
PUBLISHER_DEFAULT_REF [androidJvm]
const val ~~PUBLISHER_DEFAULT_REF~~: String
SCROLL_NAME [androidJvm]
const val ~~SCROLL_NAME~~: String
SCROLL_REF [androidJvm]
const val ~~SCROLL_REF~~: String
TEXT_ALIGNMENT_NAME [androidJvm]
const val ~~TEXT_ALIGNMENT_NAME~~: String
TEXT_ALIGNMENT_REF [androidJvm]
const val ~~TEXT_ALIGNMENT_REF~~: String
WORD_SPACING_NAME [androidJvm]
const val ~~WORD_SPACING_NAME~~: String
WORD_SPACING_REF [androidJvm]
const val ~~WORD_SPACING_REF~~: String