plugins.core.accessibility.md

docs » plugins.core.accessibility

---

Accessibility Plugin.

API Overview

• Constants - Useful values which cannot be changed
• enabled
• Variables - Configurable values
• systemPreferencesAlreadyOpen
• Functions - API calls offered directly by the extension
• completeSetupPanel
• init
• showSetupPanel

API Documentation

Constants

enabled

Signature	plugins.core.accessibility.enabled <cp.prop: boolean; read-only>
Type	Constant
Description	Is true if Accessibility permissions have been enabled for CommandPost.

Variables

systemPreferencesAlreadyOpen

Signature	plugins.core.accessibility.systemPreferencesAlreadyOpen
Type	Variable
Description	Was System Preferences already open?

Functions

completeSetupPanel

Signature	plugins.core.accessibility.completeSetupPanel() -> none
Type	Function
Description	Called when the setup panel for accessibility was shown and is ready to complete.
Parameters	None
Returns	None

init

Signature	plugins.core.accessibility.init(setup) -> table
Type	Function
Description	Initialises the module.
Parameters	setup - Dependancies setup
Returns	The module as a table

showSetupPanel

Signature	plugins.core.accessibility.showSetupPanel() -> none
Type	Function
Description	Called when the Setup Panel should be shown to prompt the user about enabling Accessbility.
Parameters	None
Returns	None