Skip to content

D
Docs

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

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

Update docs (16423) 

Signed-off-by: Nester.zhou <ester.zhou@huawei.com>
上级 c13bab30
隐藏空白更改
内联 并排
Showing with 201 addition and 201 deletion
en/application-dev/reference/apis/js-apis-accessibility.md
浏览文件 @ f9b89d85
......@@ -68,20 +68,20 @@ Describes the target action supported by an accessibility application.
| -------- | -------- |
| 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.|
| scrollForward | Scrolling forward. Not supported currently. |
| scrollBackward | Scrolling backward. Not supported currently. |
| focus | Obtaining focus. Not supported currently. |
| clearFocus | Clearing focus. Not supported currently. |
| clearSelection | Clearing selection. Not supported currently. |
| accessibilityFocus | Obtaining the accessibility focus. |
| clearAccessibilityFocus | Clearing the accessibility focus. |
| cut | Cut. Not supported currently. |
| copy | Copy. Not supported currently. |
| paste | Paste. Not supported currently. |
| select | Select. Not supported currently. |
| setText | Setting the text. Not supported currently. |
| delete | Delete. Not supported currently. |
| setSelection | Setting the selection. Not supported currently. |
## Capability
......@@ -94,7 +94,7 @@ Enumerates the capabilities of an accessibility application.
| 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.|
| zoom | Capability to control the display zoom level. Not supported currently. |
| gesture | Capability to perform gesture actions.|
## CaptionsFontEdgeType<sup>8+</sup>
......@@ -279,15 +279,15 @@ Describes a GUI change event.
| 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.|
| description | string | Yes| Yes| Event description. Not supported currently. |
| 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. Not supported currently. |
| 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.|
| beginIndex | number | Yes| Yes| Sequence number of the first item displayed on the page. Not supported currently. |
| currentIndex | number | Yes| Yes| Sequence number of the current item. Not supported currently. |
| endIndex | number | Yes| Yes| Sequence number of the last item displayed on the page. Not supported currently. |
| itemCount | number | Yes| Yes| Total number of items. Not supported currently. |
### constructor
......@@ -323,13 +323,13 @@ Enumerates accessibility event types.
| -------- | -------- |
| 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.|
| select | Event of selecting a component. Not supported currently. |
| focus | Event indicating that the component obtains the focus. Not supported currently. |
| textUpdate | Event indicating that the component text has been updated. Not supported currently. |
| hoverEnter | Event indicating that the hover enters a component. Not supported currently. |
| hoverExit | Event indicating that the hover exits a component. Not supported currently. |
| scroll | Event of the scroll view. Not supported currently. |
| textSelectionUpdate | Event indicating that the selected text has been updated. Not supported currently. |
| accessibilityFocus | Event indicating that the accessibility focus has been obtained.|
| accessibilityFocusClear | Event indicating that the accessibility focus has been cleared.|
......
en/application-dev/reference/apis/js-apis-application-accessibilityExtensionAbility.md
浏览文件 @ f9b89d85
......@@ -16,9 +16,9 @@ import AccessibilityExtensionAbility from '@ohos.application.AccessibilityExtens
**System capability**: SystemCapability.BarrierFree.Accessibility.Core
| Name | Type| Readable| Writable| Description |
| --------- | -------- | ---- | ---- | ------------------------- |
| context | [AccessibilityExtensionContext](js-apis-inner-application-accessibilityExtensionContext.md) | Yes| No| Context of the accessibility extension ability.|
| Name | Type | Readable | Writable | Description |
| ------- | ---------------------------------------- | ---- | ---- | ------------ |
| context | [AccessibilityExtensionContext](js-apis-inner-application-accessibilityExtensionContext.md) | Yes | No | Context of the accessibility extension ability.|
## AccessibilityEvent
......@@ -28,11 +28,11 @@ Defines an accessibility event.
### Attributes
| Name | Type | Readable | Writable | Description |
| --------- | ---------------------------------------- | ---- | ---- | ---------- |
| eventType | [accessibility.EventType](js-apis-accessibility.md#EventType) \| [accessibility.WindowUpdateType](js-apis-accessibility.md#WindowUpdateType) \| [TouchGuideType](#touchguidetype) \| [GestureType](#gesturetype) \| [PageUpdateType](#pageupdatetype) | Yes | No | Event type. |
| target | [AccessibilityElement](js-apis-inner-application-accessibilityExtensionContext.md#accessibilityelement9) | Yes | No | Target component where the event occurs.|
| timeStamp | number | Yes | No | Timestamp of the event. |
| Name | Type | Readable| Writable| Description |
| --------- | ------------------------------------------------------------ | ---- | ---- | ------------------------------------------------------------ |
| eventType | [accessibility.EventType](js-apis-accessibility.md#EventType) \| [accessibility.WindowUpdateType](js-apis-accessibility.md#WindowUpdateType)\| [TouchGuideType](#touchguidetype) \| [GestureType](#gesturetype) \| [PageUpdateType](#pageupdatetype) | Yes | No | Event type.<br>**EventType**: accessibility event type.<br>**WindowUpdateType**: Window update type.<br>**TouchGuideType**: touch guide event type.<br>**GestureType**: gesture type.<br>**PageUpdateType**: page update type, which is not supported currently.|
| target | [AccessibilityElement](js-apis-inner-application-accessibilityExtensionContext.md#accessibilityelement9) | Yes | No | Target component where the event occurs. |
| timeStamp | number | Yes | No | Timestamp of the event. |
## GestureType
......@@ -40,35 +40,35 @@ Enumerates gesture types.
**System capability**: SystemCapability.BarrierFree.Accessibility.Core
| Name | Description |
| ------------- | ------------ |
| left | Left gesture. String type. |
| leftThenRight | Left-then-right gesture. String type. |
| leftThenUp | Left-then-up gesture. String type. |
| leftThenDown | Left-then-down gesture. String type. |
| right | Right gesture. String type. |
| rightThenLeft | Right-then-left gesture. String type. |
| rightThenUp | Right-then-up gesture. String type. |
| rightThenDown | Right-then-down gesture. String type. |
| up | Up gesture. String type. |
| upThenLeft | Up-then-left gesture. String type. |
| upThenRight | Up-then-right gesture. String type. |
| upThenDown | Up-then-down gesture. String type. |
| down | Down gesture. String type. |
| downThenLeft | Down-then-left gesture. String type. |
| downThenRight | Down-then-right gesture. String type. |
| downThenUp | Down-then-up gesture. String type. |
| Name | Description |
| ------------- | ------------------- |
| left | Left gesture. String type. |
| leftThenRight | Left-then-right gesture. String type.|
| leftThenUp | Left-then-up gesture. String type.|
| leftThenDown | Left-then-down gesture. String type.|
| right | Right gesture. String type. |
| rightThenLeft | Right-then-left gesture. String type.|
| rightThenUp | Right-then-up gesture. String type.|
| rightThenDown | Right-then-down gesture. String type.|
| up | Up gesture. String type. |
| upThenLeft | Up-then-left gesture. String type.|
| upThenRight | Up-then-right gesture. String type.|
| upThenDown | Up-then-down gesture. String type.|
| down | Down gesture. String type. |
| downThenLeft | Down-then-left gesture. String type.|
| downThenRight | Down-then-right gesture. String type.|
| downThenUp | Down-then-up gesture. String type.|
## PageUpdateType
Enumerates the page update types.
Enumerates the page update types. This API is not supported currently.
**System capability**: SystemCapability.BarrierFree.Accessibility.Core
| Name | Description |
| ----------------- | --------- |
| pageContentUpdate | Update of the page content. String type. |
| pageStateUpdate | Update of the page status. String type. |
| Name | Description |
| ----------------- | ---------------- |
| pageContentUpdate | Update of the page content. String type.|
| pageStateUpdate | Update of the page status. String type.|
## TouchGuideType
......@@ -76,10 +76,10 @@ Enumerates the touch guide event types.
**System capability**: SystemCapability.BarrierFree.Accessibility.Core
| Name | Description |
| ---------- | ------------ |
| touchBegin | Start of touch in touch guide mode. String type. |
| touchEnd | End of touch in touch guide mode. String type. |
| Name | Description |
| ---------- | ------------------- |
| touchBegin | Start of touch in touch guide mode. String type.|
| touchEnd | End of touch in touch guide mode. String type.|
## AccessibilityExtensionAbility.onConnect
......@@ -127,7 +127,7 @@ Called when an event that matches the specified bundle and event type occurs. In
**Parameters**
| Name | Type | Mandatory | Description |
| Name | Type | Mandatory | Description |
| ----- | ---------------------------------------- | ---- | --------------- |
| event | [AccessibilityEvent](#accessibilityevent) | Yes | Accessibility event. No value is returned.|
......@@ -154,7 +154,7 @@ Called when a physical key is pressed. In this API, you can determine whether to
**Parameters**
| Name | Type | Mandatory | Description |
| Name | Type | Mandatory | Description |
| -------- | ---------------------------------------- | ---- | ----------------------- |
| keyEvent | [KeyEvent](js-apis-keyevent.md#KeyEvent) | Yes | Key event. If **true** is returned, the key is intercepted.|
......
en/application-dev/reference/apis/js-apis-inner-application-accessibilityExtensionContext.md
浏览文件 @ f9b89d85
......@@ -57,7 +57,7 @@ Defines a rectangle.
**System capability**: SystemCapability.BarrierFree.Accessibility.Core
| Name | Type | Readable | Writable | Description |
| Name | Type | Readable | Writable | Description |
| ------ | ------ | ---- | ---- | --------- |
| left | number | Yes | No | Left boundary of the rectangle.|
| top | number | Yes | No | Top boundary of the rectangle.|
......@@ -85,14 +85,14 @@ Sets the concerned target bundle. This API uses a promise to return the result.
**Parameters**
| Name | Type | Mandatory | Description |
| Name | Type | Mandatory | Description |
| ----------- | ------------------- | ---- | -------- |
| targetNames | Array&lt;string&gt; | Yes | Name of the target bundle.|
**Return value**
| Type | Description |
| ---------------------- | --------------------- |
| Type | Description |
| ------------------- | ---------------- |
| Promise&lt;void&gt; | Promise that returns no value.|
**Example**
......@@ -120,9 +120,9 @@ Sets the concerned target bundle. This API uses an asynchronous callback to retu
**Parameters**
| Name | Type | Mandatory | Description |
| ----------- | ------------------- | ---- | -------- |
| targetNames | Array&lt;string&gt; | Yes | Name of the target bundle.|
| Name | Type | Mandatory | Description |
| ----------- | ------------------------- | ---- | ---------------------------------------- |
| targetNames | Array&lt;string&gt; | Yes | Name of the target bundle. |
| callback | AsyncCallback&lt;void&gt; | Yes | Callback used to return the result. If the operation fails, **error** that contains data is returned.|
**Example**
......@@ -152,7 +152,7 @@ Obtains the focus element. This API uses a promise to return the result.
**Parameters**
| Name | Type | Mandatory | Description |
| Name | Type | Mandatory | Description |
| -------------------- | ------- | ---- | ------------------- |
| isAccessibilityFocus | boolean | No | Whether the obtained focus element is an accessibility focus. The default value is **false**.|
......@@ -166,8 +166,8 @@ Obtains the focus element. This API uses a promise to return the result.
For details about the error codes, see [Accessibility Error Codes](../errorcodes/errorcode-accessibility.md).
| ID| Error Message|
| ------- | -------------------------------- |
| ID | Error Message |
| ------- | ---------------------------------------- |
| 9300003 | Do not have accessibility right for this operation. |
**Example**
......@@ -196,16 +196,16 @@ Obtains the focus element. This API uses an asynchronous callback to return the
**Parameters**
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;AccessibilityElement&gt; | Yes | Callback used to return the current focus element.|
| Name | Type | Mandatory | Description |
| -------- | ---------------------------------------- | ---- | ----------------- |
| callback | AsyncCallback&lt;AccessibilityElement&gt; | Yes | Callback used to return the current focus element.|
**Error codes**
For details about the error codes, see [Accessibility Error Codes](../errorcodes/errorcode-accessibility.md).
| ID| Error Message|
| ------- | -------------------------------- |
| ID | Error Message |
| ------- | ---------------------------------------- |
| 9300003 | Do not have accessibility right for this operation. |
**Example**
......@@ -236,10 +236,10 @@ Obtains the focus element. This API uses an asynchronous callback to return the
**Parameters**
| Name | Type | Mandatory | Description |
| -------------------- | ------- | ---- | ------------------- |
| isAccessibilityFocus | boolean | Yes | Whether the obtained focus element is an accessibility focus.|
| callback | AsyncCallback&lt;AccessibilityElement&gt; | Yes | Callback used to return the current focus element.|
| Name | Type | Mandatory | Description |
| -------------------- | ---------------------------------------- | ---- | ----------------- |
| isAccessibilityFocus | boolean | Yes | Whether the obtained focus element is an accessibility focus. |
| callback | AsyncCallback&lt;AccessibilityElement&gt; | Yes | Callback used to return the current focus element.|
**Example**
......@@ -269,8 +269,8 @@ Obtains the root element of a window. This API uses a promise to return the resu
**Parameters**
| Name | Type | Mandatory | Description |
| -------------------- | ------- | ---- | ------------------- |
| Name | Type | Mandatory | Description |
| -------- | ------ | ---- | ---------------------- |
| windowId | number | No | Window for which you want to obtain the root element. If this parameter is not specified, it indicates the current active window.|
**Return value**
......@@ -283,8 +283,8 @@ Obtains the root element of a window. This API uses a promise to return the resu
For details about the error codes, see [Accessibility Error Codes](../errorcodes/errorcode-accessibility.md).
| ID| Error Message|
| ------- | -------------------------------- |
| ID | Error Message |
| ------- | ---------------------------------------- |
| 9300003 | Do not have accessibility right for this operation. |
**Example**
......@@ -313,16 +313,16 @@ Obtains the root element of a window. This API uses an asynchronous callback to
**Parameters**
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;AccessibilityElement&gt; | Yes | Callback used to return the root element.|
| Name | Type | Mandatory | Description |
| -------- | ---------------------------------------- | ---- | ------------------ |
| callback | AsyncCallback&lt;AccessibilityElement&gt; | Yes | Callback used to return the root element.|
**Error codes**
For details about the error codes, see [Accessibility Error Codes](../errorcodes/errorcode-accessibility.md).
| ID| Error Message|
| ------- | -------------------------------- |
| ID | Error Message |
| ------- | ---------------------------------------- |
| 9300003 | Do not have accessibility right for this operation. |
**Example**
......@@ -353,17 +353,17 @@ Obtains the root element of a window. This API uses an asynchronous callback to
**Parameters**
| Name | Type | Mandatory | Description |
| -------------------- | ------- | ---- | ------------------- |
| windowId | number | Yes | Window for which you want to obtain the root element. If this parameter is not specified, it indicates the current active window.|
| callback | AsyncCallback&lt;AccessibilityElement&gt; | Yes | Callback used to return the root element.|
| Name | Type | Mandatory | Description |
| -------- | ---------------------------------------- | ---- | ---------------------- |
| windowId | number | Yes | Window for which you want to obtain the root element. If this parameter is not specified, it indicates the current active window.|
| callback | AsyncCallback&lt;AccessibilityElement&gt; | Yes | Callback used to return the root element. |
**Error codes**
For details about the error codes, see [Accessibility Error Codes](../errorcodes/errorcode-accessibility.md).
| ID| Error Message|
| ------- | -------------------------------- |
| ID | Error Message |
| ------- | ---------------------------------------- |
| 9300003 | Do not have accessibility right for this operation. |
**Example**
......@@ -395,22 +395,22 @@ Obtains the list of windows on a display. This API uses a promise to return the
**Parameters**
| Name | Type | Mandatory | Description |
| -------------------- | ------- | ---- | ------------------- |
| Name | Type | Mandatory | Description |
| --------- | ------ | ---- | --------------------- |
| displayId | number | No | ID of the display from which the window information is obtained. If this parameter is not specified, it indicates the default main display.|
**Return value**
| Type | Description |
| ----------------------------------- | ---------------------- |
| Type | Description |
| ---------------------------------------- | ---------------------- |
| Promise&lt;Array&lt;AccessibilityElement&gt;&gt; | Promise used to return the window list.|
**Error codes**
For details about the error codes, see [Accessibility Error Codes](../errorcodes/errorcode-accessibility.md).
| ID| Error Message|
| ------- | -------------------------------- |
| ID | Error Message |
| ------- | ---------------------------------------- |
| 9300003 | Do not have accessibility right for this operation. |
**Example**
......@@ -439,16 +439,16 @@ Obtains the list of windows on a display. This API uses an asynchronous callback
**Parameters**
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;Array&lt;AccessibilityElement&gt;&gt; | Yes | Callback used to return the window list.|
| Name | Type | Mandatory | Description |
| -------- | ---------------------------------------- | ---- | ----------------- |
| callback | AsyncCallback&lt;Array&lt;AccessibilityElement&gt;&gt; | Yes | Callback used to return the window list.|
**Error codes**
For details about the error codes, see [Accessibility Error Codes](../errorcodes/errorcode-accessibility.md).
| ID| Error Message|
| ------- | -------------------------------- |
| ID | Error Message |
| ------- | ---------------------------------------- |
| 9300003 | Do not have accessibility right for this operation. |
**Example**
......@@ -479,17 +479,17 @@ Obtains the list of windows on a display. This API uses an asynchronous callback
**Parameters**
| Name | Type | Mandatory | Description |
| -------------------- | ------- | ---- | ------------------- |
| displayId | number | Yes | ID of the display from which the window information is obtained. If this parameter is not specified, it indicates the default main display.|
| callback | AsyncCallback&lt;Array&lt;AccessibilityElement&gt;&gt; | Yes | Callback used to return the window list.|
| Name | Type | Mandatory | Description |
| --------- | ---------------------------------------- | ---- | --------------------- |
| displayId | number | Yes | ID of the display from which the window information is obtained. If this parameter is not specified, it indicates the default main display.|
| callback | AsyncCallback&lt;Array&lt;AccessibilityElement&gt;&gt; | Yes | Callback used to return the window list. |
**Error codes**
For details about the error codes, see [Accessibility Error Codes](../errorcodes/errorcode-accessibility.md).
| ID| Error Message|
| ------- | -------------------------------- |
| ID | Error Message |
| ------- | ---------------------------------------- |
| 9300003 | Do not have accessibility right for this operation. |
**Example**
......@@ -521,22 +521,22 @@ Inject a gesture. This API uses a promise to return the result.
**Parameters**
| Name | Type | Mandatory | Description |
| ----------- | ---------------------------------------- | ---- | -------------- |
| gesturePath | [GesturePath](js-apis-accessibility-GesturePath.md#gesturepath) | Yes | Path of the gesture to inject. |
| Name | Type | Mandatory | Description |
| ----------- | ---------------------------------------- | ---- | ---------- |
| gesturePath | [GesturePath](js-apis-accessibility-GesturePath.md#gesturepath) | Yes | Path of the gesture to inject.|
**Return value**
| Type | Description |
| ----------------------------------- | ---------------------- |
| Type | Description |
| ------------------- | ---------------- |
| Promise&lt;void&gt; | Promise that returns no value.|
**Error codes**
For details about the error codes, see [Accessibility Error Codes](../errorcodes/errorcode-accessibility.md).
| ID| Error Message|
| ------- | -------------------------------- |
| ID | Error Message |
| ------- | ---------------------------------------- |
| 9300003 | Do not have accessibility right for this operation. |
**Example**
......@@ -569,17 +569,17 @@ Inject a gesture. This API uses an asynchronous callback to return the result.
**Parameters**
| Name | Type | Mandatory | Description |
| ----------- | ---------------------------------------- | ---- | -------------- |
| gesturePath | [GesturePath](js-apis-accessibility-GesturePath.md#gesturepath) | Yes | Path of the gesture to inject. |
| callback | AsyncCallback&lt;void&gt; | Yes | Callback used to return the result.|
| Name | Type | Mandatory | Description |
| ----------- | ---------------------------------------- | ---- | ------------------- |
| gesturePath | [GesturePath](js-apis-accessibility-GesturePath.md#gesturepath) | Yes | Path of the gesture to inject. |
| callback | AsyncCallback&lt;void&gt; | Yes | Callback used to return the result.|
**Error codes**
For details about the error codes, see [Accessibility Error Codes](../errorcodes/errorcode-accessibility.md).
| ID| Error Message|
| ------- | -------------------------------- |
| ID | Error Message |
| ------- | ---------------------------------------- |
| 9300003 | Do not have accessibility right for this operation. |
**Example**
......@@ -620,8 +620,8 @@ Obtains all attribute names of this element. This API uses a promise to return t
**Return value**
| Type | Description |
| ---------------------------------------- | ------------------------ |
| Type | Description |
| ----------------------------- | ------------------------ |
| Promise&lt;Array&lt;T&gt;&gt; | Promise used to return all attribute names of the element.|
**Example**
......@@ -646,9 +646,9 @@ Obtains all attribute names of this element. This API uses an asynchronous callb
**Parameters**
| Name | Type | Mandatory | Description |
| ----------- | ---------------------------------------- | ---- | -------------- |
| callback | AsyncCallback&lt;Array&lt;T&gt;&gt; | Yes | Callback used to return all attribute names of the element.|
| Name | Type | Mandatory | Description |
| -------- | ----------------------------------- | ---- | ------------------- |
| callback | AsyncCallback&lt;Array&lt;T&gt;&gt; | Yes | Callback used to return all attribute names of the element.|
**Example**
......@@ -674,22 +674,22 @@ Obtains the attribute value based on an attribute name. This API uses a promise
**Parameters**
| Name | Type | Mandatory | Description |
| ----------- | ---------------------------------------- | ---- | -------------- |
| attributeName | T | Yes | Attribute name. |
| Name | Type | Mandatory | Description |
| ------------- | ---- | ---- | -------- |
| attributeName | T | Yes | Attribute name.|
**Return value**
| Type | Description |
| ---------------------------------------- | ------------------------ |
| Type | Description |
| ---------------------------------------- | --------------------------- |
| Promise&lt;ElementAttributeValues[T]&gt; | Promise used to return the attribute value.|
**Error codes**
For details about the error codes, see [Accessibility Error Codes](../errorcodes/errorcode-accessibility.md).
| ID| Error Message|
| ------- | -------------------------------- |
| ID | Error Message |
| ------- | ----------------------------- |
| 9300004 | This property does not exist. |
**Example**
......@@ -720,17 +720,17 @@ Obtains the attribute value based on an attribute name. This API uses an asynchr
**Parameters**
| Name | Type | Mandatory | Description |
| ----------- | ---------------------------------------- | ---- | -------------- |
| attributeName | T | Yes | Attribute name. |
| callback | AsyncCallback&lt;ElementAttributeValues[T]&gt; | Yes | Callback used to return the attribute value.|
| Name | Type | Mandatory | Description |
| ------------- | ---------------------------------------- | ---- | ---------------------- |
| attributeName | T | Yes | Attribute name. |
| callback | AsyncCallback&lt;ElementAttributeValues[T]&gt; | Yes | Callback used to return the attribute value.|
**Error codes**
For details about the error codes, see [Accessibility Error Codes](../errorcodes/errorcode-accessibility.md).
| ID| Error Message|
| ------- | -------------------------------- |
| ID | Error Message |
| ------- | ----------------------------- |
| 9300004 | This property does not exist. |
**Example**
......@@ -762,8 +762,8 @@ Obtains the names of all actions supported by this element. This API uses a prom
**Return value**
| Type | Description |
| ---------------------------------------- | ------------------------ |
| Type | Description |
| ---------------------------------- | -------------------------- |
| Promise&lt;Array&lt;string&gt;&gt; | Promise used to return the names of all actions supported by the element.|
**Example**
......@@ -788,9 +788,9 @@ Obtains the names of all actions supported by this element. This API uses an asy
**Parameters**
| Name | Type | Mandatory | Description |
| ----------- | ---------------------------------------- | ---- | -------------- |
| callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | Yes | Callback used to return the names of all actions supported by the element.|
| Name | Type | Mandatory | Description |
| -------- | ---------------------------------------- | ---- | --------------------- |
| callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | Yes | Callback used to return the names of all actions supported by the element.|
**Example**
......@@ -818,21 +818,21 @@ Performs an action based on the specified action name. This API uses a promise t
| Name | Type | Mandatory | Description |
| ----------- | ---------------------------------------- | ---- | -------------- |
| actionName | string | Yes | Action name. For details, see [Action](./js-apis-accessibility.md#action).
| parameters | object | No | Parameter required for performing the target action. |
| actionName | string | Yes | Action name. For details, see [Action](./js-apis-accessibility.md#action). |
| parameters | object | No | Parameters required for performing the target action. Not supported currently. |
**Return value**
| Type | Description |
| ---------------------------------------- | ------------------------ |
| Type | Description |
| ------------------- | ---------------- |
| Promise&lt;void&gt; | Promise that returns no value.|
**Error codes**
For details about the error codes, see [Accessibility Error Codes](../errorcodes/errorcode-accessibility.md).
| ID| Error Message|
| ------- | -------------------------------- |
| ID | Error Message |
| ------- | ----------------------------- |
| 9300005 | This action is not supported. |
**Example**
......@@ -861,15 +861,15 @@ Performs an action based on the specified action name. This API uses an asynchro
| Name | Type | Mandatory | Description |
| ----------- | ---------------------------------------- | ---- | -------------- |
| actionName | string | Yes | Action name. For details, see [Action](./js-apis-accessibility.md#action).
| actionName | string | Yes | Action name. For details, see [Action](./js-apis-accessibility.md#action). |
| callback | AsyncCallback&lt;void&gt; | Yes | Callback used to return the result.|
**Error codes**
For details about the error codes, see [Accessibility Error Codes](../errorcodes/errorcode-accessibility.md).
| ID| Error Message|
| ------- | -------------------------------- |
| ID | Error Message |
| ------- | ----------------------------- |
| 9300005 | This action is not supported. |
**Example**
......@@ -898,18 +898,18 @@ Performs an action based on the specified action name. This API uses an asynchro
**Parameters**
| Name | Type | Mandatory | Description |
| ----------- | ---------------------------------------- | ---- | -------------- |
| actionName | string | Yes | Action name. For details, see [Action](./js-apis-accessibility.md#action).|
| parameters | object | Yes | Parameter required for performing the target action. |
| callback | AsyncCallback&lt;void&gt; | Yes | Callback used to return the result.|
| Name | Type | Mandatory | Description |
| ---------- | ------------------------- | ---- | ---------------------------------------- |
| actionName | string | Yes | Action name. For details, see [Action](./js-apis-accessibility.md#action).|
| parameters | object | Yes | Parameters required for performing the target action. Not supported currently. |
| callback | AsyncCallback&lt;void&gt; | Yes | Callback used to return the result. |
**Error codes**
For details about the error codes, see [Accessibility Error Codes](../errorcodes/errorcode-accessibility.md).
| ID| Error Message|
| ------- | -------------------------------- |
| ID | Error Message |
| ------- | ----------------------------- |
| 9300005 | This action is not supported. |
**Example**
......@@ -942,15 +942,15 @@ Queries the element information of the **content** type. This API uses a promise
**Parameters**
| Name | Type | Mandatory | Description |
| ----------- | ---------------------------------------- | ---- | -------------- |
| type | string | Yes | Information type. The value is fixed at **'content'**. |
| condition | string | Yes | Search criteria. |
| Name | Type | Mandatory | Description |
| --------- | ------ | ---- | ----------------------------- |
| type | string | Yes | Information type. The value is fixed at **'content'**.|
| condition | string | Yes | Search criteria. |
**Return value**
| Type | Description |
| ---------------------------------------- | ------------------------ |
| Type | Description |
| ---------------------------------------- | ----------------------------- |
| Promise&lt;Array&lt;AccessibilityElement&gt;&gt; | Promise used to return the result.|
**Example**
......@@ -981,11 +981,11 @@ Queries the element information of the **content** type. This API uses an asynch
**Parameters**
| Name | Type | Mandatory | Description |
| ----------- | ---------------------------------------- | ---- | -------------- |
| type | string | Yes | Information type. The value is fixed at **'content'**. |
| condition | string | Yes | Search criteria. |
| callback | AsyncCallback&lt;Array&lt;AccessibilityElement&gt;&gt; | Yes | Callback used to return the result.|
| Name | Type | Mandatory | Description |
| --------- | ---------------------------------------- | ---- | ---------------------------- |
| type | string | Yes | Information type. The value is fixed at **'content'**.|
| condition | string | Yes | Search criteria. |
| callback | AsyncCallback&lt;Array&lt;AccessibilityElement&gt;&gt; | Yes | Callback used to return the result. |
**Example**
......@@ -1017,15 +1017,15 @@ Queries the element information of the **focusType** type. This API uses a promi
**Parameters**
| Name | Type | Mandatory | Description |
| ----------- | ---------------------------------------- | ---- | -------------- |
| type | string | Yes | Information type. The value is fixed at **'focusType'**. |
| condition | [FocusType](#focustype) | Yes | Enumerates the focus types. |
| Name | Type | Mandatory | Description |
| --------- | ----------------------- | ---- | ---------------------------------- |
| type | string | Yes | Information type. The value is fixed at **'focusType'**.|
| condition | [FocusType](#focustype) | Yes | Enumerates the focus types. |
**Return value**
| Type | Description |
| ---------------------------------------- | ------------------------ |
| Type | Description |
| ----------------------------------- | ------------------------------ |
| Promise&lt;AccessibilityElement&gt; | Promise used to return the result.|
**Example**
......@@ -1056,11 +1056,11 @@ Queries the element information of the **focusType** type. This API uses an asyn
**Parameters**
| Name | Type | Mandatory | Description |
| ----------- | ---------------------------------------- | ---- | -------------- |
| type | string | Yes | Information type. The value is fixed at **'focusType'**. |
| condition | [FocusType](#focustype) | Yes | Enumerates the focus types. |
| callback | AsyncCallback&lt;AccessibilityElement&gt; | Yes | Callback used to return the result.|
| Name | Type | Mandatory | Description |
| --------- | ---------------------------------------- | ---- | ---------------------------------- |
| type | string | Yes | Information type. The value is fixed at **'focusType'**.|
| condition | [FocusType](#focustype) | Yes | Enumerates the focus types. |
| callback | AsyncCallback&lt;AccessibilityElement&gt; | Yes | Callback used to return the result. |
**Example**
......@@ -1092,15 +1092,15 @@ Queries the element information of the **focusDirection** type. This API uses a
**Parameters**
| Name | Type | Mandatory | Description |
| ----------- | ---------------------------------------- | ---- | -------------- |
| type | string | Yes | Information type. The value is fixed at **'focusDirection'**. |
| condition | [FocusDirection](#focusdirection) | Yes | Enumerates the focus directions. |
| Name | Type | Mandatory | Description |
| --------- | --------------------------------- | ---- | ---------------------------------------- |
| type | string | Yes | Information type. The value is fixed at **'focusDirection'**.|
| condition | [FocusDirection](#focusdirection) | Yes | Enumerates the focus directions. |
**Return value**
| Type | Description |
| ---------------------------------------- | ------------------------ |
| Type | Description |
| ----------------------------------- | -------------------------------- |
| Promise&lt;AccessibilityElement&gt; | Promise used to return the result.|
**Example**
......@@ -1131,11 +1131,11 @@ Queries the element information of the **focusDirection** type. This API uses an
**Parameters**
| Name | Type | Mandatory | Description |
| ----------- | ---------------------------------------- | ---- | -------------- |
| type | string | Yes | Information type. The value is fixed at **'focusDirection'**. |
| condition | [FocusDirection](#focusdirection) | Yes | Direction of the next focus element. |
| callback | AsyncCallback&lt;AccessibilityElement&gt; | Yes | Callback used to return the result.|
| Name | Type | Mandatory | Description |
| --------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | string | Yes | Information type. The value is fixed at **'focusDirection'**.|
| condition | [FocusDirection](#focusdirection) | Yes | Direction of the next focus element. |
| callback | AsyncCallback&lt;AccessibilityElement&gt; | Yes | Callback used to return the result. |
**Example**
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或