Skip to content

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

Accessibility

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

Holds the accessibility metadata of a Publication.

https://www.w3.org/2021/a11y-discov-vocab/latest/ https://readium.org/webpub-manifest/schema/a11y.schema.json

Constructors

Accessibility [androidJvm]
fun Accessibility(conformsTo: Set<Accessibility.Profile>, certification: Accessibility.Certification? = null, summary: String? = null, accessModes: Set<Accessibility.AccessMode>, accessModesSufficient: Set<Set<Accessibility.PrimaryAccessMode>>, features: Set<Accessibility.Feature>, hazards: Set<Accessibility.Hazard>)

Types

Name Summary
AccessMode [androidJvm]
@JvmInline
value class AccessMode(val value: String) : Parcelable
A human sensory perceptual system or cognitive faculty through which a person may process or perceive information.
Certification [androidJvm]
data class Certification(val certifiedBy: String?, val credential: String?, val report: String?) : JSONable, Parcelable
Certification of accessible publications.
Companion [androidJvm]
object Companion
Feature [androidJvm]
@JvmInline
value class Feature(val value: String) : Parcelable
A content feature of the described resource, such as accessible media, alternatives and supported enhancements for accessibility.
Hazard [androidJvm]
@JvmInline
value class Hazard(val value: String) : Parcelable
A characteristic of the described resource that is physiologically dangerous to some users.
PrimaryAccessMode [androidJvm]
@Serializable
enum PrimaryAccessMode : Enum<Accessibility.PrimaryAccessMode> , Parcelable
A human primary sensory perceptual system or cognitive faculty through which a person may process or perceive information.
Profile [androidJvm]
@JvmInline
value class Profile(val uri: String) : Parcelable
Accessibility profile.

Functions

Name Summary
describeContents [androidJvm]
abstract fun describeContents(): Int
toJSON [androidJvm]
open override fun toJSON(): JSONObject
Serializes the object to its JSON representation.
writeToParcel [androidJvm]
abstract fun writeToParcel(p0: Parcel, p1: Int)

Properties

Name Summary
accessModes [androidJvm]
val accessModes: Set<Accessibility.AccessMode>
The human sensory perceptual system or cognitive faculty through which a person may process or perceive information.
accessModesSufficient [androidJvm]
val accessModesSufficient: Set<Set<Accessibility.PrimaryAccessMode>>
A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource.
certification [androidJvm]
val certification: Accessibility.Certification? = null
Certification of accessible publications.
conformsTo [androidJvm]
val conformsTo: Set<Accessibility.Profile>
An established standard to which the described resource conforms.
features [androidJvm]
val features: Set<Accessibility.Feature>
Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility.
hazards [androidJvm]
val hazards: Set<Accessibility.Hazard>
A characteristic of the described resource that is physiologically dangerous to some users.
summary [androidJvm]
val summary: String? = null
A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed."