Accessibility

Members

(inner, constant) Messages :String

Available message types

Properties:

Name	Type	Description
`WELCOME`	String	WELCOME
`KB_MENU`	String	KB_MENU
`CONTINUE`	String	CONTINUE
`KB_TOGGLE`	String	KB_TOGGLE
`VOICE_MENU`	String	VOICE_MENU
`VOICE_CHOSEN`	String	VOICE_CHOSEN
`VOLUME_UP`	String	VOLUME_UP
`VOLUME_DOWN`	String	VOLUME_DOWN
`VOLUME_MENU`	String	VOLUME_MENU
`VOLUME_LEVEL`	String	VOLUME_LEVEL
`VOLUME_LEVEL_MIN`	String	VOLUME_LEVEL_MIN
`VOLUME_LEVEL_MAX`	String	VOLUME_LEVEL_MAX
`SPEECH_RATE_MENU`	String	SPEECH_RATE_MENU
`SPEECH_RATE_UP`	String	SPEECH_RATE_UP
`SPEECH_RATE_DOWN`	String	SPEECH_RATE_DOWN
`SPEECH_RATE_MENU`	String	SPEECH_RATE_MENU
`SPEECH_RATE`	String	SPEECH_RATE
`SPEECH_RATE_MIN`	String	SPEECH_RATE_MIN
`SPEECH_RATE_MAX`	String	SPEECH_RATE_MAX
`SETTINGS_MENU`	String	SETTINGS_MENU
`DEVICE_VOLUME`	String	DEVICE_VOLUME
`ARIA_REQUIRED_FIELD`	String	ARIA_REQUIRED_FIELD
`ARIA_DISABLED_FIELD`	String	ARIA_DISABLED_FIELD
`BUTTON_DISABLED`	String	BUTTON_DISABLED
`INPUT_MAX_LEN`	String	INPUT_MAX_LEN
`INPUT_MIN_LEN`	String	INPUT_MIN_LEN
`INPUT_SIZE`	String	INPUT_SIZE
`INPUT_READONLY`	String	INPUT_READONLY
`INPUT_REQUIRED`	String	INPUT_REQUIRED
`INPUT_MIN_MAX`	String	INPUT_MIN_MAX
`INPUT_MAX`	String	INPUT_MAX
`INPUT_MIN`	String	INPUT_MIN
`INPUT_STEP`	String	INPUT_STEP
`INPUT_MIN_VALUE`	String	INPUT_MIN_VALUE
`INPUT_MAX_VALUE`	String	INPUT_MAX_VALUE
`INPUT_CHECKED_IS`	String	INPUT_CHECKED_IS
`INPUT_CHECKED_NOT`	String	INPUT_CHECKED_NOT
`INPUT_TOGGLE_CHECK`	String	INPUT_TOGGLE_CHECK
`INPUT_VALUE`	String	INPUT_VALUE
`SELECT_CHOOSE_ONE`	String	SELECT_CHOOSE_ONE
`SELECT_ROTATE_OPT`	String	SELECT_ROTATE_OPT
`SELECT_CURRENT`	String	SELECT_CURRENT
`SYSTEM_VOICE_MENU`	String	SYSTEM_VOICE_MENU
`VOICE_ANNOUNCE`	String	VOICE_ANNOUNCE
`PRIVACY_MENU`	String	PRIVACY_MENU
`PRIVACY_ENABLED`	String	PRIVACY_ENABLED
`PRIVACY_DISABLED`	String	PRIVACY_DISABLED

(inner, constant) Voices :String

Available voices

Properties:

Name	Type	Description
`Alex`	String	Alex
`Fred`	String	Fred
`Karen`	String	Karen
`Fiona`	String	Fiona
`Moira`	String	Moira
`Tessa`	String	Tessa
`Veena`	String	Veena
`Daniel`	String	Daniel
`Samantha`	String	Samantha
`Victoria`	String	Victoria
`"Google US English"`	String	Google US English
`"Google UK English Male"`	String	Google UK English Male
`"Google UK English Female"`	String	Google UK English Female

Type Definitions

AccessibilityInvalidHTMLElementException

Properties:

Name	Type	Description
`code`	String	The code of the error, in this case it is 'Agent.InvalidHTMLElement'
`name`	String	The name of the error, in this case it is 'AccessibilityInvalidHTMLElementException'
`stack`	String	The stack trace from where this error was instantiated.

AccessibilityInvalidMessageException

Fired when a message is passed to the setMessage function with an invalid type.

Properties:

Name	Type	Description
`code`	String	The code of the error, in this case it is 'Agent.AccessibilityInvalidMessage'
`name`	String	The name of the error, in this case it is 'AccessibilityInvalidMessageException'
`stack`	String	The stack trace from where this error was instantiated.

AccessibilityInvalidMessageNameException

Fired when a name is passed to the setMessage function with an invalid type.

Properties:

Name	Type	Description
`code`	String	The code of the error, in this case it is 'Agent.AccessibilityInvalidMessageType'
`name`	String	The name of the error, in this case it is 'AccessibilityInvalidMessageNameException'
`stack`	String	The stack trace from where this error was instantiated.

ButtonProperties :Object

Properties:

Name	Type	Description
`disabled`	Boolean	If we should read the disabled property from a button element.
`textContent`	Boolean	If we should read the textContent property from a button element.

Configuration :Object

Properties:

Name	Type	Description
`beep`	Boolean	If keypresses on the navigation device should make a beep sound.
`waitToStart`	Boolean	Should we wait for the user to confirm before starting to read the page?
`welcomeMessage`	Boolean	Should the welcome message be played when headphones are connected?
`settingMenusAtStart`	Boolean	Should we present the settings menu after the welcome message?
`voiceName`	Voices	The Voice to use as the Normal Voice.
`systemVoiceName`	Voices	The Voice to use as the System Voice
`speechRate`	SpeechRate	The Speech Rate min, max and current value.
`voiceVolume`	VoiceVolume	The Voice Volume min, max and current value.
`deviceVolume`	DeviceVolume	The Device Volume min and max.
`settingMenus`	SettingMenus	The Settings Menus to enable
`elementProperties`	ElementProperties	The Element Properties to read

ElementProperties :Object

Properties:

Name	Type	Description
`id`	Boolean	If we should read the id property of any html element
`name`	Boolean	If we should read the name property of any html element
`type`	Boolean	If we should read the element type of any html element
`textContent`	Boolean	If we should read the text content of any html element
`input`	InputProperties	The properties to read from an input element
`label`	LabelProperties	The properties to read from a label element
`button`	ButtonProperties	The properties to read from a button element

InputProperties :Object

Properties:

Name	Type	Description
`id`	Boolean	If we should read the id property from an input element.
`type`	Boolean	If we should read the type property from an input element.
`name`	Boolean	If we should read the name property from an input element.
`min`	Boolean	If we should read the min property from an input element.
`max`	Boolean	If we should read the max property from an input element.
`step`	Boolean	If we should read the step property from an input element.
`maxLength`	Boolean	If we should read the maxLength property from an input element.
`minLength`	Boolean	If we should read the minLength property from an input element.
`size`	Boolean	If we should read the size property from an input element.
`readOnly`	Boolean	If we should read the readOnly property from an input element.
`required`	Boolean	If we should read the required property from an input element.
`checked`	Boolean	If we should read the checked property from an input element.
`value`	Boolean	If we should read the value property from an input element.
`label`	Boolean	If we should read the label property from an input element.

Key :Object

Properties:

Name	Type	Description
`name`	String	The spoken "name" of the key
`value`	String	The writen "value" of the key

KeySet :Array.<(module:Accessibility~Key|String)>

When a string value key is provided the string is both the spoken "name" and the written "value"

LabelProperties :Object

Properties:

Name	Type	Description
`textContent`	Boolean	If we should read the textContent property from a label element.

SettingMenus :Object

Properties:

Name	Type	Description
`voiceVolume`	Boolean	If configuration of the voice volume should be available
`deviceVolume`	Boolean	If configuration of the device (Kiosk) volume should be available
`voice`	Boolean	If configuration of the voice should be available
`systemVoice`	Boolean	If configuration of the system voice should be available
`speechRate`	Boolean	If configuration of the speech rate should be available