Accessibility

data class Accessibility(val conformsTo: Set<Accessibility.Profile> = emptySet(), val certification: Accessibility.Certification? = null, val summary: String? = null, val accessModes: Set<Accessibility.AccessMode> = emptySet(), val accessModesSufficient: Set<Set<Accessibility.PrimaryAccessMode>> = emptySet(), val features: Set<Accessibility.Feature> = emptySet(), val hazards: Set<Accessibility.Hazard> = emptySet(), val exemptions: Set<Accessibility.Exemption> = emptySet()) : 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

Link copied to clipboard
constructor(conformsTo: Set<Accessibility.Profile> = emptySet(), certification: Accessibility.Certification? = null, summary: String? = null, accessModes: Set<Accessibility.AccessMode> = emptySet(), accessModesSufficient: Set<Set<Accessibility.PrimaryAccessMode>> = emptySet(), features: Set<Accessibility.Feature> = emptySet(), hazards: Set<Accessibility.Hazard> = emptySet(), exemptions: Set<Accessibility.Exemption> = emptySet())

Types

Link copied to clipboard
data class AccessMode(val value: String) : Parcelable

A human sensory perceptual system or cognitive faculty through which a person may process or perceive information.

Link copied to clipboard
data class Certification(val certifiedBy: String?, val credential: String?, val report: String?) : JSONable, Parcelable

Certification of accessible publications.

Link copied to clipboard
object Companion
Link copied to clipboard
data class Exemption(val value: String) : Parcelable

Exemption allows content creators to identify publications that do not meet conformance requirements but fall under exemptions in a given juridiction.

Link copied to clipboard
data class Feature(val value: String) : Parcelable

A content feature of the described resource, such as accessible media, alternatives and supported enhancements for accessibility.

Link copied to clipboard
data class Hazard(val value: String) : Parcelable

A characteristic of the described resource that is physiologically dangerous to some users.

Link copied to clipboard

A human primary sensory perceptual system or cognitive faculty through which a person may process or perceive information.

Link copied to clipboard
data class Profile(val uri: String) : Parcelable

Accessibility profile.

Properties

Link copied to clipboard

The human sensory perceptual system or cognitive faculty through which a person may process or perceive information.

Link copied to clipboard

A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource.

Link copied to clipboard

Certification of accessible publications.

Link copied to clipboard

An established standard to which the described resource conforms.

Link copied to clipboard

Justifications for non-conformance based on exemptions in a given jurisdiction.

Link copied to clipboard

Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility.

Link copied to clipboard

A characteristic of the described resource that is physiologically dangerous to some users.

Link copied to clipboard

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."

Functions

Link copied to clipboard
abstract fun describeContents(): Int
Link copied to clipboard
open override fun toJSON(): JSONObject

Serializes the object to its JSON representation.

Link copied to clipboard
abstract fun writeToParcel(p0: Parcel, p1: Int)