Skip to content

D
Docs

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

通知 161
Star 293
Fork 28
D
Docs
未验证 提交 9f756d6d 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!7664 翻译完成 6961：js-apis-accessibility.md 

Merge pull request !7664 from ester.zhou/TR-6961
上级 5e2c0797 b52e3347
隐藏空白更改
内联 并排
Showing with 266 addition and 259 deletion
en/application-dev/reference/apis/js-apis-accessibility.md
浏览文件 @ 9f756d6d
# 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.
## Modules to Import
......@@ -13,162 +16,162 @@ import accessibility from '@ohos.accessibility';
Enumerates the states of an accessibility application.
**System capability**: SystemCapability.Barrierfree.Accessibility.Core
**System capability**: SystemCapability.BarrierFree.Accessibility.Core
| Name | Description |
| -------- | -------- |
| enable | The accessibility application is enabled. |
| disable | The accessibility application is disabled. |
| install | The accessibility application has been installed. |
| Name| Description|
| -------- | -------- |
| enable | The accessibility application is enabled.|
| disable | The accessibility application is disabled.|
| install | The accessibility application has been installed.|
## AbilityType
Enumerates the types of accessibility applications.
**System capability**: SystemCapability.Barrierfree.Accessibility.Core
**System capability**: SystemCapability.BarrierFree.Accessibility.Core
| Name | Description |
| -------- | -------- |
| audible | The accessibility application provides audible feedback. |
| generic | The accessibility application provides generic feedback. |
| haptic | The accessibility application provides haptic feedback. |
| spoken | The accessibility application provides spoken feedback. |
| visual | The accessibility application provides visual feedback. |
| Name| Description|
| -------- | -------- |
| audible | The accessibility application provides audible feedback.|
| generic | The accessibility application provides generic feedback.|
| haptic | The accessibility application provides haptic feedback.|
| spoken | The accessibility application provides spoken feedback.|
| visual | The accessibility application provides visual feedback.|
| all<sup>9+</sup> | All the preceding types.|
## AccessibilityAbilityInfo
Provides information about an accessibility application.
**System capability**: SystemCapability.Barrierfree.Accessibility.Core
**System capability**: SystemCapability.BarrierFree.Accessibility.Core
### Attributes
| Name | Type | Readable | Writable | Description |
| -------- | -------- | -------- | -------- | -------- |
| id | number | Yes | No | Ability ID. |
| name | string | Yes | No | Ability name. |
| bundleName | string | Yes | No | Bundle name. |
| abilityTypes | Array&lt;[AbilityType](#abilitytype)&gt; | Yes | No | Accessibility application type. |
| capabilities | Array&lt;[Capability](#capability)&gt; | Yes | No | Capabilities list of the accessibility application. |
| 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. |
| Name| Type| Readable| Writable| Description|
| -------- | -------- | -------- | -------- | -------- |
| id | number | Yes| No| Ability ID.|
| name | string | Yes| No| Ability name.|
| bundleName | string | Yes| No| Bundle name.|
| targetBundleNames<sup>9+</sup> | Array&lt;string&gt; | Yes| No| Name of the target bundle.|
| abilityTypes | Array&lt;[AbilityType](#abilitytype)&gt; | Yes| No| Accessibility application type.|
| capabilities | Array&lt;[Capability](#capability)&gt; | Yes| No| Capabilities list of the accessibility application.|
| 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
Describes the target action supported by an accessibility application.
**System capability**: SystemCapability.Barrierfree.Accessibility.Core
| Name | Description |
| -------- | -------- |
| click | Clicking. |
| longClick | Long pressing. |
| scrollForward | Scrolling forward. |
| scrollBackward | Scrolling backward. |
| focus | Obtaining focus. |
| clearFocus | Clearing focus. |
| clearSelection | Clearing selection. |
| accessibilityFocus | Obtaining the accessibility focus. |
| clearAccessibilityFocus | Clearing the accessibility focus. |
| cut | Cut. |
| copy | Copy. |
| paste | Paste. |
| select | Select. |
| setText | Setting the text. |
| delete | Delete. |
| setSelection | Setting the selection. |
**System capability**: SystemCapability.BarrierFree.Accessibility.Core
| Name| Description|
| -------- | -------- |
| click | Clicking.|
| longClick | Long pressing.|
| scrollForward | Scrolling forward.|
| scrollBackward | Scrolling backward.|
| focus | Obtaining focus.|
| clearFocus | Clearing focus.|
| clearSelection | Clearing selection.|
| accessibilityFocus | Obtaining the accessibility focus.|
| clearAccessibilityFocus | Clearing the accessibility focus.|
| cut | Cut.|
| copy | Copy.|
| paste | Paste.|
| select | Select.|
| setText | Setting the text.|
| delete | Delete.|
| setSelection | Setting the selection.|
## Capability
Enumerates the capabilities of an auxiliary application.
**System capability**: SystemCapability.Barrierfree.Accessibility.Core
**System capability**: SystemCapability.BarrierFree.Accessibility.Core
| Name | Description |
| -------- | -------- |
| retrieve | Capability to retrieve the window content. |
| touchGuide | Capability of touch guide mode. |
| keyEventObserver | Capability to filter key events. |
| zoom | Capability to control the display zoom level. |
| gesture | Capability to perform gesture actions. |
| Name| Description|
| -------- | -------- |
| retrieve | Capability to retrieve the window content.|
| touchGuide | Capability of touch guide mode.|
| keyEventObserver | Capability to filter key events.|
| zoom | Capability to control the display zoom level.|
| gesture | Capability to perform gesture actions.|
## 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 |
| -------- | -------- |
| none | No effect. |
| raised | Raised effect. |
| depressed | Depressed effect. |
| uniform | Uniform effect. |
| dropShadow | Drop shadow effect. |
| Name| Description|
| -------- | -------- |
| none | No effect.|
| raised | Raised effect.|
| depressed | Depressed effect.|
| uniform | Uniform effect.|
| dropShadow | Drop shadow effect.|
## 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 |
| -------- | -------- |
| default | Default font family. |
| monospacedSerif | Monospaced Serif fonts, which use the same width for each character. |
| serif | Serif fonts. |
| monospacedSansSerif | Monospaced Sans Serif fonts, which use the same width for each character. |
| sansSerif | Sans Serif fonts. |
| casual | Casual fonts. |
| cursive | Cursive fonts. |
| smallCapitals | Small caps fonts. |
| Name| Description|
| -------- | -------- |
| default | Default font family.|
| monospacedSerif | Monospaced Serif fonts, which use the same width for each character.|
| serif | Serif fonts.|
| monospacedSansSerif | Monospaced Sans Serif fonts, which use the same width for each character.|
| sansSerif | Sans Serif fonts.|
| casual | Casual fonts.|
| cursive | Cursive fonts.|
| smallCapitals | Small caps fonts.|
## 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 |
| -------- | -------- | -------- | -------- | -------- |
| fontFamily | [CaptionsFontFamily](#captionsfontfamily8) | Yes | No | Font family of the captions. |
| fontScale | number | Yes | No | Font scale of the captions. |
| fontColor | number \ | string | Yes | No | Font color of the captions. |
| fontEdgeType | [CaptionsFontEdgeType](#captionsfontedgetype8) | Yes | No | Font edge type of the captions. |
| backgroundColor | number \ | string | Yes | No | Background color of the captions. |
| windowColor | number \ | string | Yes | No | Window color of the captions. |
| Name| Type| Readable| Writable| Description|
| -------- | -------- | -------- | -------- | -------- |
| fontFamily | [CaptionsFontFamily](#captionsfontfamily8) | Yes| No| Font family of captions.|
| fontScale | number | Yes| No| Font scale of captions.|
| fontColor | number \| string | Yes| No| Font color of captions.|
| fontEdgeType | [CaptionsFontEdgeType](#captionsfontedgetype8) | Yes| No| Font edge type of captions.|
| backgroundColor | number \| string | Yes| No| Background color of captions.|
| windowColor | number \| string | Yes| No| Window color of captions.|
## 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 |
| -------- | -------- | -------- | -------- | -------- |
| enabled | boolean | Yes | No | Whether to enable caption configuration. |
| style | [CaptionsStyle](#captionsstyle8) | Yes | No | Caption style. |
### Attributes
### 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;
Enables listening for enable status changes of caption configuration.
**System capability**: SystemCapability.Barrierfree.Accessibility.Hearing
Enables listening for enabled status changes of captions configuration.
- **Parameters**
| Name | Type | Mandatory | Description |
| -------- | -------- | -------- | -------- |
| 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. |
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
| 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 enabled status of captions configuration changes.|
- Example
- **Example**
```typescript
captionsManager.on('enableChange',(data) => {
......@@ -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;
Enables listening for caption style changes.
**System capability**: SystemCapability.Barrierfree.Accessibility.Hearing
Enables listening for captions style changes.
- **Parameters**
| Name | Type | Mandatory | Description |
| -------- | -------- | -------- | -------- |
| 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. |
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
| 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 style of captions changes.|
- Example
- **Example**
```typescript
captionsManager.on('styleChange',(data) => {
......@@ -199,43 +200,39 @@ Enables listening for caption style changes.
})
```
#### off('enableChange')
### off('enableChange')
off(type: 'enableChange', callback?: Callback&lt;boolean&gt;): void;
Disables listening for enable status changes of caption configuration.
**System capability**: SystemCapability.Barrierfree.Accessibility.Hearing
Disables listening for enabled status changes of captions configuration.
- **Parameters**
| Name | Type | Mandatory | Description |
| -------- | -------- | -------- | -------- |
| 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. |
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
| 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 enabled status of captions configuration changes.|
- Example
- **Example**
```typescript
captionsManager.off('enableChange')
```
#### off('styleChange')
### off('styleChange')
off(type: 'styleChange', callback?: Callback&lt;CaptionsStyle&gt;): void;
Disables listening for caption style changes.s is removed.
**System capability**: SystemCapability.Barrierfree.Accessibility.Hearing
Disables listening for captions style changes.
- **Parameters**
| Name | Type | Mandatory | Description |
| -------- | -------- | -------- | -------- |
| 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. |
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
| 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 style of captions changes.|
- Example
- **Example**
```typescript
captionsManager.off('styleChange')
......@@ -245,80 +242,92 @@ Disables listening for caption style changes.s is removed.
Describes a GUI change event.
**System capability**: SystemCapability.Barrierfree.Accessibility.Core
**System capability**: SystemCapability.BarrierFree.Accessibility.Core
### Attributes
| Name | Type | Readable | Writable | Description |
| -------- | -------- | -------- | -------- | -------- |
| type | [EventType](#eventtype) | Yes | Yes | Accessibility event type. |
| windowUpdateType | [WindowUpdateType](#windowupdatetype) | Yes | Yes | Window update type. |
| bundleName | string | Yes | Yes | Target application name. |
| 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. |
| description | string | Yes | Yes | Event description. |
| triggerAction | [Action](#action) | Yes | Yes | Action that triggers the event. |
| textMoveUnit | [TextMoveUnit](#textmoveunit) | Yes | Yes | Text movement unit. |
| contents | Array&lt;string&gt; | Yes | Yes | Array of contents. |
| lastContent | string | Yes | Yes | Latest content. |
| beginIndex | number | Yes | Yes | Sequence number of the first item displayed on the page. |
| currentIndex | number | Yes | Yes | Sequence number of the current item. |
| endIndex | number | Yes | Yes | Sequence number of the last item displayed on the page. |
| itemCount | number | Yes | Yes | Total number of items. |
| Name| Type| Readable| Writable| Description|
| -------- | -------- | -------- | -------- | -------- |
| type | [EventType](#eventtype) | Yes| Yes| Accessibility event type.|
| windowUpdateType | [WindowUpdateType](#windowupdatetype) | Yes| Yes| Window update type.|
| bundleName | string | Yes| Yes| Target application name.|
| 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.|
| description | string | Yes| Yes| Event description.|
| triggerAction | [Action](#action) | Yes| Yes| Action that triggers the event.|
| textMoveUnit | [TextMoveUnit](#textmoveunit) | Yes| Yes| Text movement unit.|
| contents | Array&lt;string&gt; | Yes| Yes| Array of contents.|
| lastContent | string | Yes| Yes| Latest content.|
| beginIndex | number | Yes| Yes| Sequence number of the first item displayed on the page.|
| currentIndex | number | Yes| Yes| Sequence number of the current item.|
| endIndex | number | Yes| Yes| Sequence number of the last item displayed on the page.|
| 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
Enumerates accessibility event types.
**System capability**: SystemCapability.Barrierfree.Accessibility.Core
| Name | Description |
| -------- | -------- |
| click | Event of clicking a component. |
| longClick | Event of long-pressing a component. |
| select | Event of selecting a component. |
| focus | Event indicating that the component obtains the focus. |
| textUpdate | Event indicating that the component text has been updated. |
| hoverEnter | Event indicating that the hover enters a component. |
| hoverExit | Event indicating that the hover exits a component. |
| scroll | Event of the scroll view. |
| textSelectionUpdate | Event indicating that the selected text has been updated. |
| accessibilityFocus | Event indicating that the accessibility focus has been obtained. |
| accessibilityFocusClear | Event indicating that the accessibility focus has been cleared. |
**System capability**: SystemCapability.BarrierFree.Accessibility.Core
| Name| Description|
| -------- | -------- |
| click | Event of clicking a component.|
| longClick | Event of long-pressing a component.|
| select | Event of selecting a component.|
| focus | Event indicating that the component obtains the focus.|
| textUpdate | Event indicating that the component text has been updated.|
| hoverEnter | Event indicating that the hover enters a component.|
| hoverExit | Event indicating that the hover exits a component.|
| scroll | Event of the scroll view.|
| textSelectionUpdate | Event indicating that the selected text has been updated.|
| accessibilityFocus | Event indicating that the accessibility focus has been obtained.|
| accessibilityFocusClear | Event indicating that the accessibility focus has been cleared.|
## TextMoveUnit
Enumerates the movement units for traversing the node text.
**System capability**: SystemCapability.Barrierfree.Accessibility.Core
**System capability**: SystemCapability.BarrierFree.Accessibility.Core
| Name | Description |
| -------- | -------- |
| char | The movement unit for traversing the node text is by character. |
| word | The movement unit for traversing the node text is by word. |
| line | The movement unit for traversing the node text is by line. |
| page | The movement unit for traversing the node text is by page. |
| paragraph | The movement unit for traversing the node text is by paragraph. |
| Name| Description|
| -------- | -------- |
| char | The movement unit for traversing the node text is by character.|
| word | The movement unit for traversing the node text is by word.|
| line | The movement unit for traversing the node text is by line.|
| page | The movement unit for traversing the node text is by page.|
| paragraph | The movement unit for traversing the node text is by paragraph.|
## WindowUpdateType
Enumerates window update types.
**System capability**: SystemCapability.Barrierfree.Accessibility.Core
| Name | Description |
| -------- | -------- |
| add | Window adding. |
| remove | Window deletion. |
| title | Window title change. |
| bounds | Window boundary change. |
| layer | Window layer 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. |
**System capability**: SystemCapability.BarrierFree.Accessibility.Core
| Name| Description|
| -------- | -------- |
| add | Window adding.|
| remove | Window deletion.|
| bounds | Window boundary change.|
| active | Window activity change.|
| focus | Window focus change.|
## accessibility.getAbilityLists
......@@ -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.
**System capability**: SystemCapability.Barrierfree.Accessibility.Core
**System capability**: SystemCapability.BarrierFree.Accessibility.Core
- **Parameters**
| Name | Type | Mandatory | Description |
| -------- | -------- | -------- | -------- |
| abilityType | [AbilityType](#abilitytype) | Yes | Accessibility application type. |
| stateType | [AbilityState](#abilitystate) | Yes | Accessibility application status. |
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
| abilityType | [AbilityType](#abilitytype) | Yes| Accessibility application type.|
| stateType | [AbilityState](#abilitystate) | Yes| Accessibility application status.|
- Return value
- **Return value**
| Type | Description |
| -------- | -------- |
| Promise&lt;Array&lt;[AccessibilityAbilityInfo](#accessibilityabilityinfo)&gt;&gt; | Promise used to return the accessibility application list. |
| Type| Description|
| -------- | -------- |
| Promise&lt;Array&lt;[AccessibilityAbilityInfo](#accessibilityabilityinfo)&gt;&gt; | Promise used to return the accessibility application list.|
- Example
- **Example**
```typescript
accessibility.getAbilityLists("spoken", "enable")
......@@ -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.
**System capability**: SystemCapability.Barrierfree.Accessibility.Core
**System capability**: SystemCapability.BarrierFree.Accessibility.Core
- **Parameters**
| Name | Type | Mandatory | Description |
| -------- | -------- | -------- | -------- |
| abilityType | [AbilityType](#abilitytype) | Yes | Accessibility application type. |
| 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. |
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
| abilityType | [AbilityType](#abilitytype) | Yes| Accessibility application type.|
| 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.|
- Example
- **Example**
```typescript
accessibility.getAbilityLists("visual", "enable", (err, data) => {
......@@ -406,17 +415,17 @@ Obtains the accessibility application list. This API uses an asynchronous callba
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 |
| -------- | -------- |
| [CaptionsManager](#captionsmanager8) | Accessibility caption configuration. |
| Type| Description|
| -------- | -------- |
| [CaptionsManager](#captionsmanager8) | Captions configuration.|
- Example
- **Example**
```typescript
captionsManager = accessibility.getCaptionsManager()
......@@ -430,12 +439,12 @@ Enables listening for the accessibility application or touch guide mode status c
- **Parameters**
| 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 |
| callback | Callback&lt;boolean&gt; | Yes | Callback invoked when the enable status changes. |
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
| 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 enabled status of captions configuration changes.|
- Example
- **Example**
```typescript
accessibility.on('accessibilityStateChange',(data) => {
......@@ -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
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**
| 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 |
| callback | Callback&lt;boolean&gt; | No | Callback invoked when the enable status changes. |
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
| 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 enabled status changes.|
- Example
- **Example**
```typescript
accessibility.off('accessibilityStateChange',(data) => {
......@@ -472,15 +479,15 @@ isOpenAccessibility(): Promise&lt;boolean&gt;
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 |
| -------- | -------- |
| Promise&lt;boolean&gt; | Returns **true** if accessibility is enabled; returns **false** otherwise. |
| Type| Description|
| -------- | -------- |
| Promise&lt;boolean&gt; | Returns **true** if accessibility is enabled; returns **false** otherwise.|
- Example
- **Example**
```typescript
accessibility.isOpenAccessibility()
......@@ -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.
**System capability**: SystemCapability.Barrierfree.Accessibility.Core
**System capability**: SystemCapability.BarrierFree.Accessibility.Core
- Parameters
- **Parameters**
| 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. |
| 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.|
- Example
- **Example**
```typescript
accessibility.isOpenAccessibility((err, data) => {
......@@ -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.
**System capability**: SystemCapability.Barrierfree.Accessibility.Core
**System capability**: SystemCapability.BarrierFree.Accessibility.Vision
- Return value
- **Return value**
| Type | Description |
| -------- | -------- |
| Promise&lt;boolean&gt; | Returns **true** if touch guide mode is enabled; returns **false** otherwise. |
| Type| Description|
| -------- | -------- |
| Promise&lt;boolean&gt; | Returns **true** if touch guide mode is enabled; returns **false** otherwise.|
- Example
- **Example**
```typescript
accessibility.isOpenTouchGuide()
......@@ -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.
**System capability**: SystemCapability.Barrierfree.Accessibility.Core
**System capability**: SystemCapability.BarrierFree.Accessibility.Vision
- Parameters
- **Parameters**
| 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. |
| 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.|
- Example
- **Example**
```typescript
accessibility.isOpenTouchGuide((err, data) => {
......@@ -574,21 +581,21 @@ sendEvent(event: EventInfo): Promise&lt;void&gt;
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**
| Name | Type | Mandatory | Description |
| -------- | -------- | -------- | -------- |
| event | [EventInfo](#eventinfo) | Yes | Accessibility event. |
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
| event | [EventInfo](#eventinfo) | Yes| Accessibility event.|
- Return value
- **Return value**
| 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. |
| 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.|
- Example
- **Example**
```typescript
accessibility.sendEvent(this.eventInfo)
......@@ -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.
**System capability**: SystemCapability.Barrierfree.Accessibility.Core
**System capability**: SystemCapability.BarrierFree.Accessibility.Core
- **Parameters**
| Name | Type | Mandatory | Description |
| -------- | -------- | -------- | -------- |
| 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. |
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
| 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.|
- Example
- **Example**
```typescript
accessibility.sendEvent(this.eventInfo,(err, data) => {
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或