Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
提交 b52e3347 编写于 作者: E ester.zhou
浏览文件
操作

update js-apis-accessibility.md 

Signed-off-by: Nester.zhou <ester.zhou@huawei.com>
上级 98d3da89
隐藏空白更改
内联 并排
Showing with 266 addition and 259 deletion
en/application-dev/reference/apis/js-apis-accessibility.md
浏览文件 @ b52e3347
# Accessibility # Accessibility
> **NOTE**<br> The **Accessibility** module implements the accessibility functions, including obtaining the accessibility application list, accessibility application enabled status, and captions configuration.
> **NOTE**
>
> The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version. > The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version.
## Modules to Import ## Modules to Import
...@@ -13,162 +16,162 @@ import accessibility from '@ohos.accessibility'; ...@@ -13,162 +16,162 @@ import accessibility from '@ohos.accessibility';
Enumerates the states of an accessibility application. Enumerates the states of an accessibility application.
**System capability**: SystemCapability.Barrierfree.Accessibility.Core **System capability**: SystemCapability.BarrierFree.Accessibility.Core
| Name | Description | | Name| Description|
| -------- | -------- | | -------- | -------- |
| enable | The accessibility application is enabled. | | enable | The accessibility application is enabled.|
| disable | The accessibility application is disabled. | | disable | The accessibility application is disabled.|
| install | The accessibility application has been installed. | | install | The accessibility application has been installed.|
## AbilityType ## AbilityType
Enumerates the types of accessibility applications. Enumerates the types of accessibility applications.
**System capability**: SystemCapability.Barrierfree.Accessibility.Core **System capability**: SystemCapability.BarrierFree.Accessibility.Core
| Name | Description | | Name| Description|
| -------- | -------- | | -------- | -------- |
| audible | The accessibility application provides audible feedback. | | audible | The accessibility application provides audible feedback.|
| generic | The accessibility application provides generic feedback. | | generic | The accessibility application provides generic feedback.|
| haptic | The accessibility application provides haptic feedback. | | haptic | The accessibility application provides haptic feedback.|
| spoken | The accessibility application provides spoken feedback. | | spoken | The accessibility application provides spoken feedback.|
| visual | The accessibility application provides visual feedback. | | visual | The accessibility application provides visual feedback.|
| all<sup>9+</sup> | All the preceding types.|
## AccessibilityAbilityInfo ## AccessibilityAbilityInfo
Provides information about an accessibility application. Provides information about an accessibility application.
**System capability**: SystemCapability.Barrierfree.Accessibility.Core **System capability**: SystemCapability.BarrierFree.Accessibility.Core
### Attributes ### Attributes
| Name | Type | Readable | Writable | Description | | Name| Type| Readable| Writable| Description|
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| id | number | Yes | No | Ability ID. | | id | number | Yes| No| Ability ID.|
| name | string | Yes | No | Ability name. | | name | string | Yes| No| Ability name.|
| bundleName | string | Yes | No | Bundle name. | | bundleName | string | Yes| No| Bundle name.|
| abilityTypes | Array&lt;[AbilityType](#abilitytype)&gt; | Yes | No | Accessibility application type. | | targetBundleNames<sup>9+</sup> | Array&lt;string&gt; | Yes| No| Name of the target bundle.|
| capabilities | Array&lt;[Capability](#capability)&gt; | Yes | No | Capabilities list of the accessibility application. | | abilityTypes | Array&lt;[AbilityType](#abilitytype)&gt; | Yes| No| Accessibility application type.|
| description | string | Yes | No | Description of the accessibility application. | | capabilities | Array&lt;[Capability](#capability)&gt; | Yes| No| Capabilities list of the accessibility application.|
| eventTypes | Array&lt;[EventType](#eventtype)&gt; | Yes | No | List of events that the accessibility application focuses on. | | description | string | Yes| No| Description of the accessibility application.|
| eventTypes | Array&lt;[EventType](#eventtype)&gt; | Yes| No| List of events that the accessibility application focuses on.|
## Action ## Action
Describes the target action supported by an accessibility application. Describes the target action supported by an accessibility application.
**System capability**: SystemCapability.Barrierfree.Accessibility.Core **System capability**: SystemCapability.BarrierFree.Accessibility.Core
| Name | Description | | Name| Description|
| -------- | -------- | | -------- | -------- |
| click | Clicking. | | click | Clicking.|
| longClick | Long pressing. | | longClick | Long pressing.|
| scrollForward | Scrolling forward. | | scrollForward | Scrolling forward.|
| scrollBackward | Scrolling backward. | | scrollBackward | Scrolling backward.|
| focus | Obtaining focus. | | focus | Obtaining focus.|
| clearFocus | Clearing focus. | | clearFocus | Clearing focus.|
| clearSelection | Clearing selection. | | clearSelection | Clearing selection.|
| accessibilityFocus | Obtaining the accessibility focus. | | accessibilityFocus | Obtaining the accessibility focus.|
| clearAccessibilityFocus | Clearing the accessibility focus. | | clearAccessibilityFocus | Clearing the accessibility focus.|
| cut | Cut. | | cut | Cut.|
| copy | Copy. | | copy | Copy.|
| paste | Paste. | | paste | Paste.|
| select | Select. | | select | Select.|
| setText | Setting the text. | | setText | Setting the text.|
| delete | Delete. | | delete | Delete.|
| setSelection | Setting the selection. | | setSelection | Setting the selection.|
## Capability ## Capability
Enumerates the capabilities of an auxiliary application. Enumerates the capabilities of an auxiliary application.
**System capability**: SystemCapability.Barrierfree.Accessibility.Core **System capability**: SystemCapability.BarrierFree.Accessibility.Core
| Name | Description | | Name| Description|
| -------- | -------- | | -------- | -------- |
| retrieve | Capability to retrieve the window content. | | retrieve | Capability to retrieve the window content.|
| touchGuide | Capability of touch guide mode. | | touchGuide | Capability of touch guide mode.|
| keyEventObserver | Capability to filter key events. | | keyEventObserver | Capability to filter key events.|
| zoom | Capability to control the display zoom level. | | zoom | Capability to control the display zoom level.|
| gesture | Capability to perform gesture actions. | | gesture | Capability to perform gesture actions.|
## CaptionsFontEdgeType<sup>8+</sup> ## CaptionsFontEdgeType<sup>8+</sup>
Enumerates the caption font edge type. Enumerates the font edge types of captions.
**System capability**: SystemCapability.Barrierfree.Accessibility.Hearing **System capability**: SystemCapability.BarrierFree.Accessibility.Hearing
| Name | Description | | Name| Description|
| -------- | -------- | | -------- | -------- |
| none | No effect. | | none | No effect.|
| raised | Raised effect. | | raised | Raised effect.|
| depressed | Depressed effect. | | depressed | Depressed effect.|
| uniform | Uniform effect. | | uniform | Uniform effect.|
| dropShadow | Drop shadow effect. | | dropShadow | Drop shadow effect.|
## CaptionsFontFamily<sup>8+</sup> ## CaptionsFontFamily<sup>8+</sup>
Enumerates the caption font families. Enumerates the font families of captions.
**System capability**: SystemCapability.Barrierfree.Accessibility.Hearing **System capability**: SystemCapability.BarrierFree.Accessibility.Hearing
| Name | Description | | Name| Description|
| -------- | -------- | | -------- | -------- |
| default | Default font family. | | default | Default font family.|
| monospacedSerif | Monospaced Serif fonts, which use the same width for each character. | | monospacedSerif | Monospaced Serif fonts, which use the same width for each character.|
| serif | Serif fonts. | | serif | Serif fonts.|
| monospacedSansSerif | Monospaced Sans Serif fonts, which use the same width for each character. | | monospacedSansSerif | Monospaced Sans Serif fonts, which use the same width for each character.|
| sansSerif | Sans Serif fonts. | | sansSerif | Sans Serif fonts.|
| casual | Casual fonts. | | casual | Casual fonts.|
| cursive | Cursive fonts. | | cursive | Cursive fonts.|
| smallCapitals | Small caps fonts. | | smallCapitals | Small caps fonts.|
## CaptionsStyle<sup>8+</sup> ## CaptionsStyle<sup>8+</sup>
Describes the caption style. Describes the style of captions.
**System capability**: SystemCapability.Barrierfree.Accessibility.Hearing **System capability**: SystemCapability.BarrierFree.Accessibility.Hearing
| Name | Type | Readable | Writable | Description | | Name| Type| Readable| Writable| Description|
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| fontFamily | [CaptionsFontFamily](#captionsfontfamily8) | Yes | No | Font family of the captions. | | fontFamily | [CaptionsFontFamily](#captionsfontfamily8) | Yes| No| Font family of captions.|
| fontScale | number | Yes | No | Font scale of the captions. | | fontScale | number | Yes| No| Font scale of captions.|
| fontColor | number \ | string | Yes | No | Font color of the captions. | | fontColor | number \| string | Yes| No| Font color of captions.|
| fontEdgeType | [CaptionsFontEdgeType](#captionsfontedgetype8) | Yes | No | Font edge type of the captions. | | fontEdgeType | [CaptionsFontEdgeType](#captionsfontedgetype8) | Yes| No| Font edge type of captions.|
| backgroundColor | number \ | string | Yes | No | Background color of the captions. | | backgroundColor | number \| string | Yes| No| Background color of captions.|
| windowColor | number \ | string | Yes | No | Window color of the captions. | | windowColor | number \| string | Yes| No| Window color of captions.|
## CaptionsManager<sup>8+</sup> ## CaptionsManager<sup>8+</sup>
Implements caption configuration management. Implements configuration management for captions.
### Attributes **System capability**: SystemCapability.BarrierFree.Accessibility.Hearing
| Name | Type | Readable | Writable | Description | ### Attributes
| -------- | -------- | -------- | -------- | -------- |
| enabled | boolean | Yes | No | Whether to enable caption configuration. |
| style | [CaptionsStyle](#captionsstyle8) | Yes | No | Caption style. |
### Methods | Name| Type| Readable| Writable| Description|
| -------- | -------- | -------- | -------- | -------- |
| enabled | boolean | Yes| No| Whether to enable captions configuration.|
| style | [CaptionsStyle](#captionsstyle8) | Yes| No| Style of captions.|
In the following API examples, you must first use the [accessibility.getCaptionsManager()](#accessibilitygetcaptionsmanager8) method to obtain a **captionsManager** instance, and then call the methods using the obtained instance. In the following API examples, you must first use the [accessibility.getCaptionsManager()](#accessibilitygetcaptionsmanager8) API to obtain a **captionsManager** instance, and then call the methods using the obtained instance.
#### on('enableChange') ### on('enableChange')
on(type: 'enableChange', callback: Callback&lt;boolean&gt;): void; on(type: 'enableChange', callback: Callback&lt;boolean&gt;): void;
Enables listening for enable status changes of caption configuration. Enables listening for enabled status changes of captions configuration.
**System capability**: SystemCapability.Barrierfree.Accessibility.Hearing
- **Parameters** - **Parameters**
| Name | Type | Mandatory | Description | | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | Yes | Type of the event to listen for, which is set to **enableChange** in this API. | | type | string | Yes| Type of the event to listen for, which is set to **enableChange** in this API.|
| callback | Callback&lt;boolean&gt; | Yes | Callback invoked when the enable status of caption configuration changes. | | callback | Callback&lt;boolean&gt; | Yes| Callback invoked when the enabled status of captions configuration changes.|
- Example - **Example**
```typescript ```typescript
captionsManager.on('enableChange',(data) => { captionsManager.on('enableChange',(data) => {
...@@ -176,22 +179,20 @@ Enables listening for enable status changes of caption configuration. ...@@ -176,22 +179,20 @@ Enables listening for enable status changes of caption configuration.
}) })
``` ```
#### on('styleChange') ### on('styleChange')
on(type: 'styleChange', callback: Callback&lt;CaptionsStyle&gt;): void; on(type: 'styleChange', callback: Callback&lt;CaptionsStyle&gt;): void;
Enables listening for caption style changes. Enables listening for captions style changes.
**System capability**: SystemCapability.Barrierfree.Accessibility.Hearing
- **Parameters** - **Parameters**
| Name | Type | Mandatory | Description | | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | Yes | Type of the event to listen for, which is set to **styleChange** in this API. | | type | string | Yes| Type of the event to listen for, which is set to **styleChange** in this API.|
| callback | Callback&lt;[CaptionsStyle](#captionsstyle8)&gt; | Yes | Callback invoked when the caption style changes. | | callback | Callback&lt;[CaptionsStyle](#captionsstyle8)&gt; | Yes| Callback invoked when the style of captions changes.|
- Example - **Example**
```typescript ```typescript
captionsManager.on('styleChange',(data) => { captionsManager.on('styleChange',(data) => {
...@@ -199,43 +200,39 @@ Enables listening for caption style changes. ...@@ -199,43 +200,39 @@ Enables listening for caption style changes.
}) })
``` ```
#### off('enableChange') ### off('enableChange')
off(type: 'enableChange', callback?: Callback&lt;boolean&gt;): void; off(type: 'enableChange', callback?: Callback&lt;boolean&gt;): void;
Disables listening for enable status changes of caption configuration. Disables listening for enabled status changes of captions configuration.
**System capability**: SystemCapability.Barrierfree.Accessibility.Hearing
- **Parameters** - **Parameters**
| Name | Type | Mandatory | Description | | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | Yes | Type of the event to listen for, which is set to **enableChange** in this API. | | type | string | Yes| Type of the event to listen for, which is set to **enableChange** in this API.|
| callback | Callback&lt;boolean&gt; | No | Callback invoked when the enable status of caption configuration changes. | | callback | Callback&lt;boolean&gt; | No| Callback invoked when the enabled status of captions configuration changes.|
- Example - **Example**
```typescript ```typescript
captionsManager.off('enableChange') captionsManager.off('enableChange')
``` ```
#### off('styleChange') ### off('styleChange')
off(type: 'styleChange', callback?: Callback&lt;CaptionsStyle&gt;): void; off(type: 'styleChange', callback?: Callback&lt;CaptionsStyle&gt;): void;
Disables listening for caption style changes.s is removed. Disables listening for captions style changes.
**System capability**: SystemCapability.Barrierfree.Accessibility.Hearing
- **Parameters** - **Parameters**
| Name | Type | Mandatory | Description | | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | Yes | Type of the event to listen for, which is set to **styleChange** in this API. | | type | string | Yes| Type of the event to listen for, which is set to **styleChange** in this API.|
| callback | Callback&lt;[CaptionsStyle](#captionsstyle8)&gt; | No | Callback invoked when the caption style changes. | | callback | Callback&lt;[CaptionsStyle](#captionsstyle8)&gt; | No| Callback invoked when the style of captions changes.|
- Example - **Example**
```typescript ```typescript
captionsManager.off('styleChange') captionsManager.off('styleChange')
...@@ -245,80 +242,92 @@ Disables listening for caption style changes.s is removed. ...@@ -245,80 +242,92 @@ Disables listening for caption style changes.s is removed.
Describes a GUI change event. Describes a GUI change event.
**System capability**: SystemCapability.Barrierfree.Accessibility.Core **System capability**: SystemCapability.BarrierFree.Accessibility.Core
### Attributes ### Attributes
| Name | Type | Readable | Writable | Description | | Name| Type| Readable| Writable| Description|
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| type | [EventType](#eventtype) | Yes | Yes | Accessibility event type. | | type | [EventType](#eventtype) | Yes| Yes| Accessibility event type.|
| windowUpdateType | [WindowUpdateType](#windowupdatetype) | Yes | Yes | Window update type. | | windowUpdateType | [WindowUpdateType](#windowupdatetype) | Yes| Yes| Window update type.|
| bundleName | string | Yes | Yes | Target application name. | | bundleName | string | Yes| Yes| Target application name.|
| componentType | string | Yes | Yes | Type of the event source component, for example, button or chart. | | componentType | string | Yes| Yes| Type of the event source component, for example, button or chart.|
| pageId | number | Yes | Yes | Page ID of the event source. | | pageId | number | Yes| Yes| Page ID of the event source.|
| description | string | Yes | Yes | Event description. | | description | string | Yes| Yes| Event description.|
| triggerAction | [Action](#action) | Yes | Yes | Action that triggers the event. | | triggerAction | [Action](#action) | Yes| Yes| Action that triggers the event.|
| textMoveUnit | [TextMoveUnit](#textmoveunit) | Yes | Yes | Text movement unit. | | textMoveUnit | [TextMoveUnit](#textmoveunit) | Yes| Yes| Text movement unit.|
| contents | Array&lt;string&gt; | Yes | Yes | Array of contents. | | contents | Array&lt;string&gt; | Yes| Yes| Array of contents.|
| lastContent | string | Yes | Yes | Latest content. | | lastContent | string | Yes| Yes| Latest content.|
| beginIndex | number | Yes | Yes | Sequence number of the first item displayed on the page. | | beginIndex | number | Yes| Yes| Sequence number of the first item displayed on the page.|
| currentIndex | number | Yes | Yes | Sequence number of the current item. | | currentIndex | number | Yes| Yes| Sequence number of the current item.|
| endIndex | number | Yes | Yes | Sequence number of the last item displayed on the page. | | endIndex | number | Yes| Yes| Sequence number of the last item displayed on the page.|
| itemCount | number | Yes | Yes | Total number of items. | | itemCount | number | Yes| Yes| Total number of items.|
### constructor
constructor(jsonObject)
Implements a constructor.
- **Parameters**
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
| jsonObject | string | Yes| JSON string required for creating an object.|
- **Example**
```typescript
let eventInfo = new accessibility.EventInfo({"type":"click","bundleName":"com.example.MyApplication","triggerAction":"click"})
```
## EventType ## EventType
Enumerates accessibility event types. Enumerates accessibility event types.
**System capability**: SystemCapability.Barrierfree.Accessibility.Core **System capability**: SystemCapability.BarrierFree.Accessibility.Core
| Name | Description | | Name| Description|
| -------- | -------- | | -------- | -------- |
| click | Event of clicking a component. | | click | Event of clicking a component.|
| longClick | Event of long-pressing a component. | | longClick | Event of long-pressing a component.|
| select | Event of selecting a component. | | select | Event of selecting a component.|
| focus | Event indicating that the component obtains the focus. | | focus | Event indicating that the component obtains the focus.|
| textUpdate | Event indicating that the component text has been updated. | | textUpdate | Event indicating that the component text has been updated.|
| hoverEnter | Event indicating that the hover enters a component. | | hoverEnter | Event indicating that the hover enters a component.|
| hoverExit | Event indicating that the hover exits a component. | | hoverExit | Event indicating that the hover exits a component.|
| scroll | Event of the scroll view. | | scroll | Event of the scroll view.|
| textSelectionUpdate | Event indicating that the selected text has been updated. | | textSelectionUpdate | Event indicating that the selected text has been updated.|
| accessibilityFocus | Event indicating that the accessibility focus has been obtained. | | accessibilityFocus | Event indicating that the accessibility focus has been obtained.|
| accessibilityFocusClear | Event indicating that the accessibility focus has been cleared. | | accessibilityFocusClear | Event indicating that the accessibility focus has been cleared.|
## TextMoveUnit ## TextMoveUnit
Enumerates the movement units for traversing the node text. Enumerates the movement units for traversing the node text.
**System capability**: SystemCapability.Barrierfree.Accessibility.Core **System capability**: SystemCapability.BarrierFree.Accessibility.Core
| Name | Description | | Name| Description|
| -------- | -------- | | -------- | -------- |
| char | The movement unit for traversing the node text is by character. | | char | The movement unit for traversing the node text is by character.|
| word | The movement unit for traversing the node text is by word. | | word | The movement unit for traversing the node text is by word.|
| line | The movement unit for traversing the node text is by line. | | line | The movement unit for traversing the node text is by line.|
| page | The movement unit for traversing the node text is by page. | | page | The movement unit for traversing the node text is by page.|
| paragraph | The movement unit for traversing the node text is by paragraph. | | paragraph | The movement unit for traversing the node text is by paragraph.|
## WindowUpdateType ## WindowUpdateType
Enumerates window update types. Enumerates window update types.
**System capability**: SystemCapability.Barrierfree.Accessibility.Core **System capability**: SystemCapability.BarrierFree.Accessibility.Core
| Name | Description | | Name| Description|
| -------- | -------- | | -------- | -------- |
| add | Window adding. | | add | Window adding.|
| remove | Window deletion. | | remove | Window deletion.|
| title | Window title change. | | bounds | Window boundary change.|
| bounds | Window boundary change. | | active | Window activity change.|
| layer | Window layer change. | | focus | Window focus change.|
| active | Window activity change. |
| focus | Window focus change. |
| accessibilityFocus | Window accessibility focus change. |
| parent | Parent window change. |
| children | Child window change. |
| pip | Picture-in-picture (PIP) mode change. |
## accessibility.getAbilityLists ## accessibility.getAbilityLists
...@@ -326,22 +335,22 @@ getAbilityLists(abilityType: AbilityType, stateType: AbilityState): Promise&lt;A ...@@ -326,22 +335,22 @@ getAbilityLists(abilityType: AbilityType, stateType: AbilityState): Promise&lt;A
Obtains the accessibility application list. This API uses a promise to return the result. Obtains the accessibility application list. This API uses a promise to return the result.
**System capability**: SystemCapability.Barrierfree.Accessibility.Core **System capability**: SystemCapability.BarrierFree.Accessibility.Core
- **Parameters** - **Parameters**
| Name | Type | Mandatory | Description | | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| abilityType | [AbilityType](#abilitytype) | Yes | Accessibility application type. | | abilityType | [AbilityType](#abilitytype) | Yes| Accessibility application type.|
| stateType | [AbilityState](#abilitystate) | Yes | Accessibility application status. | | stateType | [AbilityState](#abilitystate) | Yes| Accessibility application status.|
- Return value - **Return value**
| Type | Description | | Type| Description|
| -------- | -------- | | -------- | -------- |
| Promise&lt;Array&lt;[AccessibilityAbilityInfo](#accessibilityabilityinfo)&gt;&gt; | Promise used to return the accessibility application list. | | Promise&lt;Array&lt;[AccessibilityAbilityInfo](#accessibilityabilityinfo)&gt;&gt; | Promise used to return the accessibility application list.|
- Example - **Example**
```typescript ```typescript
accessibility.getAbilityLists("spoken", "enable") accessibility.getAbilityLists("spoken", "enable")
...@@ -369,17 +378,17 @@ getAbilityLists(abilityType: AbilityType, stateType: AbilityState,callback: Asyn ...@@ -369,17 +378,17 @@ getAbilityLists(abilityType: AbilityType, stateType: AbilityState,callback: Asyn
Obtains the accessibility application list. This API uses an asynchronous callback to return the result. Obtains the accessibility application list. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.Barrierfree.Accessibility.Core **System capability**: SystemCapability.BarrierFree.Accessibility.Core
- **Parameters** - **Parameters**
| Name | Type | Mandatory | Description | | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| abilityType | [AbilityType](#abilitytype) | Yes | Accessibility application type. | | abilityType | [AbilityType](#abilitytype) | Yes| Accessibility application type.|
| stateType | [AbilityState](#abilitystate) | Yes | Accessibility application status. | | stateType | [AbilityState](#abilitystate) | Yes| Accessibility application status.|
| callback | AsyncCallback&lt;Array&lt;[AccessibilityAbilityInfo](#accessibilityabilityinfo)&gt;&gt; | Yes | Callback used to return the accessibility application list. | | callback | AsyncCallback&lt;Array&lt;[AccessibilityAbilityInfo](#accessibilityabilityinfo)&gt;&gt; | Yes| Callback used to return the accessibility application list.|
- Example - **Example**
```typescript ```typescript
accessibility.getAbilityLists("visual", "enable", (err, data) => { accessibility.getAbilityLists("visual", "enable", (err, data) => {
...@@ -406,17 +415,17 @@ Obtains the accessibility application list. This API uses an asynchronous callba ...@@ -406,17 +415,17 @@ Obtains the accessibility application list. This API uses an asynchronous callba
getCaptionsManager(): CaptionsManager getCaptionsManager(): CaptionsManager
Obtains the accessibility caption configuration. Obtains the captions configuration.
**System capability**: SystemCapability.Barrierfree.Accessibility.Hearing **System capability**: SystemCapability.BarrierFree.Accessibility.Hearing
- Return value - **Return value**
| Type | Description | | Type| Description|
| -------- | -------- | | -------- | -------- |
| [CaptionsManager](#captionsmanager8) | Accessibility caption configuration. | | [CaptionsManager](#captionsmanager8) | Captions configuration.|
- Example - **Example**
```typescript ```typescript
captionsManager = accessibility.getCaptionsManager() captionsManager = accessibility.getCaptionsManager()
...@@ -430,12 +439,12 @@ Enables listening for the accessibility application or touch guide mode status c ...@@ -430,12 +439,12 @@ Enables listening for the accessibility application or touch guide mode status c
- **Parameters** - **Parameters**
| Name | Type | Mandatory | Description | | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | Yes | Type of the event to listen for.<br>-&nbsp;**accessibilityStateChange** means to listen for enable status changes of the accessibility application.<br>**System capability**: SystemCapability.Barrierfree.Accessibility.Core<br>-&nbsp;**touchGuideStateChange** means to listen for enable status changes of the touch guide mode.<br>**System capability**: SystemCapability.Barrierfree.Accessibility.Vision | | type | string | Yes| Type of the event to listen for.<br>- **'accessibilityStateChange'** means to listen for enabled status changes of the accessibility application.<br>**System capability**: SystemCapability.BarrierFree.Accessibility.Core<br>- **'touchGuideStateChange'** means to listen for enabled status changes of the touch guide mode.<br>**System capability**: SystemCapability.BarrierFree.Accessibility.Vision|
| callback | Callback&lt;boolean&gt; | Yes | Callback invoked when the enable status changes. | | callback | Callback&lt;boolean&gt; | Yes| Callback invoked when the enabled status of captions configuration changes.|
- Example - **Example**
```typescript ```typescript
accessibility.on('accessibilityStateChange',(data) => { accessibility.on('accessibilityStateChange',(data) => {
...@@ -447,18 +456,16 @@ Enables listening for the accessibility application or touch guide mode status c ...@@ -447,18 +456,16 @@ Enables listening for the accessibility application or touch guide mode status c
off(type: 'accessibilityStateChange ' | 'touchGuideStateChange', callback?: Callback&lt;boolean&gt;): void off(type: 'accessibilityStateChange ' | 'touchGuideStateChange', callback?: Callback&lt;boolean&gt;): void
Disables listening for the accessibility application or touch guide mode status changes. Disables listening for the accessibility application or touch guide mode status changes.
- **Parameters** - **Parameters**
| Name | Type | Mandatory | Description | | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | No | Type of the event to listen for.<br>-&nbsp;**accessibilityStateChange** means to listen for enable status changes of the accessibility application.<br>**System capability**: SystemCapability.Barrierfree.Accessibility.Core<br>-&nbsp;**touchGuideStateChange** means to listen for enable status changes of the touch guide mode.<br>**System capability**: SystemCapability.Barrierfree.Accessibility.Vision | | type | string | No| Type of the event to listen for.<br>- **'accessibilityStateChange'** means to listen for enabled status changes of the accessibility application.<br>**System capability**: SystemCapability.BarrierFree.Accessibility.Core<br>- **'touchGuideStateChange'** means to listen for enabled status changes of the touch guide mode.<br>**System capability**: SystemCapability.BarrierFree.Accessibility.Vision|
| callback | Callback&lt;boolean&gt; | No | Callback invoked when the enable status changes. | | callback | Callback&lt;boolean&gt; | No| Callback invoked when the enabled status changes.|
- Example - **Example**
```typescript ```typescript
accessibility.off('accessibilityStateChange',(data) => { accessibility.off('accessibilityStateChange',(data) => {
...@@ -472,15 +479,15 @@ isOpenAccessibility(): Promise&lt;boolean&gt; ...@@ -472,15 +479,15 @@ isOpenAccessibility(): Promise&lt;boolean&gt;
Checks whether accessibility is enabled. This API uses a promise to return the result. Checks whether accessibility is enabled. This API uses a promise to return the result.
**System capability**: SystemCapability.Barrierfree.Accessibility.Core **System capability**: SystemCapability.BarrierFree.Accessibility.Core
- Return value - **Return value**
| Type | Description | | Type| Description|
| -------- | -------- | | -------- | -------- |
| Promise&lt;boolean&gt; | Returns **true** if accessibility is enabled; returns **false** otherwise. | | Promise&lt;boolean&gt; | Returns **true** if accessibility is enabled; returns **false** otherwise.|
- Example - **Example**
```typescript ```typescript
accessibility.isOpenAccessibility() accessibility.isOpenAccessibility()
...@@ -497,15 +504,15 @@ isOpenAccessibility(callback: AsyncCallback&lt;boolean&gt;): void ...@@ -497,15 +504,15 @@ isOpenAccessibility(callback: AsyncCallback&lt;boolean&gt;): void
Checks whether accessibility is enabled. This API uses an asynchronous callback to return the result. Checks whether accessibility is enabled. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.Barrierfree.Accessibility.Core **System capability**: SystemCapability.BarrierFree.Accessibility.Core
- Parameters - **Parameters**
| Name | Type | Mandatory | Description | | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;boolean&gt; | Yes | Callback used to return the result. Returns **true** if accessibility is enabled; returns **false** otherwise. | | callback | AsyncCallback&lt;boolean&gt; | Yes| Callback used to return the result. Returns **true** if accessibility is enabled; returns **false** otherwise.|
- Example - **Example**
```typescript ```typescript
accessibility.isOpenAccessibility((err, data) => { accessibility.isOpenAccessibility((err, data) => {
...@@ -523,15 +530,15 @@ isOpenTouchGuide(): Promise&lt;boolean&gt; ...@@ -523,15 +530,15 @@ isOpenTouchGuide(): Promise&lt;boolean&gt;
Checks whether touch guide mode is enabled. This API uses a promise to return the result. Checks whether touch guide mode is enabled. This API uses a promise to return the result.
**System capability**: SystemCapability.Barrierfree.Accessibility.Core **System capability**: SystemCapability.BarrierFree.Accessibility.Vision
- Return value - **Return value**
| Type | Description | | Type| Description|
| -------- | -------- | | -------- | -------- |
| Promise&lt;boolean&gt; | Returns **true** if touch guide mode is enabled; returns **false** otherwise. | | Promise&lt;boolean&gt; | Returns **true** if touch guide mode is enabled; returns **false** otherwise.|
- Example - **Example**
```typescript ```typescript
accessibility.isOpenTouchGuide() accessibility.isOpenTouchGuide()
...@@ -548,15 +555,15 @@ isOpenTouchGuide(callback: AsyncCallback&lt;boolean&gt;): void ...@@ -548,15 +555,15 @@ isOpenTouchGuide(callback: AsyncCallback&lt;boolean&gt;): void
Checks whether touch guide mode is enabled. This API uses an asynchronous callback to return the result. Checks whether touch guide mode is enabled. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.Barrierfree.Accessibility.Core **System capability**: SystemCapability.BarrierFree.Accessibility.Vision
- Parameters - **Parameters**
| Name | Type | Mandatory | Description | | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;boolean&gt; | Yes | Callback used to return the result. Returns **true** if touch guide mode is enabled; returns **false** otherwise. | | callback | AsyncCallback&lt;boolean&gt; | Yes| Callback used to return the result. Returns **true** if touch guide mode is enabled; returns **false** otherwise.|
- Example - **Example**
```typescript ```typescript
accessibility.isOpenTouchGuide((err, data) => { accessibility.isOpenTouchGuide((err, data) => {
...@@ -574,21 +581,21 @@ sendEvent(event: EventInfo): Promise&lt;void&gt; ...@@ -574,21 +581,21 @@ sendEvent(event: EventInfo): Promise&lt;void&gt;
Sends an accessibility event. This API uses a promise to return the result. Sends an accessibility event. This API uses a promise to return the result.
**System capability**: SystemCapability.Barrierfree.Accessibility.Core **System capability**: SystemCapability.BarrierFree.Accessibility.Core
- **Parameters** - **Parameters**
| Name | Type | Mandatory | Description | | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| event | [EventInfo](#eventinfo) | Yes | Accessibility event. | | event | [EventInfo](#eventinfo) | Yes| Accessibility event.|
- Return value - **Return value**
| Type | Description | | Type| Description|
| -------- | -------- | | -------- | -------- |
| Promise&lt;void&gt; | Promise used to return the result. Returns data if the accessibility event is sent successfully; returns an error otherwise. | | Promise&lt;void&gt; | Promise used to return the result. Returns data if the accessibility event is sent successfully; returns an error otherwise.|
- Example - **Example**
```typescript ```typescript
accessibility.sendEvent(this.eventInfo) accessibility.sendEvent(this.eventInfo)
...@@ -605,16 +612,16 @@ sendEvent(event: EventInfo, callback: AsyncCallback&lt;void&gt;): void ...@@ -605,16 +612,16 @@ sendEvent(event: EventInfo, callback: AsyncCallback&lt;void&gt;): void
Sends an accessibility event. This API uses an asynchronous callback to return the result. Sends an accessibility event. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.Barrierfree.Accessibility.Core **System capability**: SystemCapability.BarrierFree.Accessibility.Core
- **Parameters** - **Parameters**
| Name | Type | Mandatory | Description | | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| event | [EventInfo](#eventinfo) | Yes | Accessibility event. | | event | [EventInfo](#eventinfo) | Yes| Accessibility event.|
| callback | AsyncCallback&lt;void&gt; | Yes | Callback used to return the result. Returns data if the accessibility event is sent successfully; returns an error otherwise. | | callback | AsyncCallback&lt;void&gt; | Yes| Callback used to return the result. Returns data if the accessibility event is sent successfully; returns an error otherwise.|
- Example - **Example**
```typescript ```typescript
accessibility.sendEvent(this.eventInfo,(err, data) => { accessibility.sendEvent(this.eventInfo,(err, data) => {
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或