Skip to content

D
Docs

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

通知 159
Star 292
Fork 28
D
Docs
提交 53e5ce74 编写于 作者: H HelloCrease
浏览文件
操作

update docs 

Signed-off-by: NHelloCrease <lian15@huawei.com>
上级 0d1e9382
展开全部 隐藏空白更改
内联 并排
Showing with 225 addition and 225 deletion
zh-cn/application-dev/reference/apis/js-apis-accessibility-extension-context.md
浏览文件 @ 53e5ce74
...@@ -12,7 +12,7 @@ AccessibilityExtensionContext模块提供扩展的上下文的能力，包括允 ...@@ -12,7 +12,7 @@ AccessibilityExtensionContext模块提供扩展的上下文的能力，包括允
## 导入模块 ## 导入模块
```js ```js
import AccessibilityExtensionAbility from './@ohos.application.AccessibilityExtensionAbility' import AccessibilityExtensionAbility from '@ohos.application.AccessibilityExtensionAbility'
``` ```
## FocusDirection ## FocusDirection
...@@ -21,13 +21,13 @@ import AccessibilityExtensionAbility from './@ohos.application.AccessibilityExte ...@@ -21,13 +21,13 @@ import AccessibilityExtensionAbility from './@ohos.application.AccessibilityExte
**系统能力**：以下各项对应的系统能力均为 SystemCapability.Barrierfree.Accessibility.Core **系统能力**：以下各项对应的系统能力均为 SystemCapability.Barrierfree.Accessibility.Core
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------- | ------- |
| up | 表示向上查询。 | | up | 表示向上查询。 |
| down | 表示向上查询。 | | down | 表示向上查询。 |
| left | 表示向左查询。 | | left | 表示向左查询。 |
| right | 表示向右查询。 | | right | 表示向右查询。 |
| forward | 表示向前查询。 | | forward | 表示向前查询。 |
| backward | 表示向后查询。 | | backward | 表示向后查询。 |
## FocusType ## FocusType
...@@ -36,10 +36,10 @@ import AccessibilityExtensionAbility from './@ohos.application.AccessibilityExte ...@@ -36,10 +36,10 @@ import AccessibilityExtensionAbility from './@ohos.application.AccessibilityExte
**系统能力**：以下各项对应的系统能力均为 SystemCapability.Barrierfree.Accessibility.Core **系统能力**：以下各项对应的系统能力均为 SystemCapability.Barrierfree.Accessibility.Core
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ------------- | ----------- |
| accessibility | 表示无障碍的焦点类型。 | | accessibility | 表示无障碍的焦点类型。 |
| normal | 表示普通的焦点类型。 | | normal | 表示普通的焦点类型。 |
## Rect ## Rect
...@@ -49,12 +49,12 @@ import AccessibilityExtensionAbility from './@ohos.application.AccessibilityExte ...@@ -49,12 +49,12 @@ import AccessibilityExtensionAbility from './@ohos.application.AccessibilityExte
### 参数 ### 参数
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ------ | -------- | ---- | ---- | ------------------ | | ------ | ------ | ---- | ---- | --------- |
| left | number | 是 | 否 | 矩形区域的左边界。 | | left | number | 是 | 否 | 矩形区域的左边界。 |
| top | number | 是 | 否 | 矩形区域的上边界。 | | top | number | 是 | 否 | 矩形区域的上边界。 |
| width | number | 是 | 否 | 矩形区域的宽度。 | | width | number | 是 | 否 | 矩形区域的宽度。 |
| height | number | 是 | 否 | 矩形区域的高度。 | | height | number | 是 | 否 | 矩形区域的高度。 |
## WindowType ## WindowType
...@@ -62,10 +62,10 @@ import AccessibilityExtensionAbility from './@ohos.application.AccessibilityExte ...@@ -62,10 +62,10 @@ import AccessibilityExtensionAbility from './@ohos.application.AccessibilityExte
**系统能力**：以下各项对应的系统能力均为 SystemCapability.Barrierfree.Accessibility.Core **系统能力**：以下各项对应的系统能力均为 SystemCapability.Barrierfree.Accessibility.Core
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ----------- | --------- |
| application | 表示应用窗口类型。 | | application | 表示应用窗口类型。 |
| system | 表示系统窗口类型。 | | system | 表示系统窗口类型。 |
## AccessibilityExtensionContext.setEventTypeFilter ## AccessibilityExtensionContext.setEventTypeFilter
...@@ -77,14 +77,14 @@ setEventTypeFilter(type: Array<accessibility.EventType>): Promise\<boolean>; ...@@ -77,14 +77,14 @@ setEventTypeFilter(type: Array<accessibility.EventType>): Promise\<boolean>;
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 说明 | | 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ | | ---- | ---------------------------------------- | ---- | -------- |
| type | Array&lt;[EventType](js-apis-accessibility.md#EventType)&gt; | 是 | 关注的事件类型。 | | type | Array&lt;[EventType](js-apis-accessibility.md#EventType)&gt; | 是 | 关注的事件类型。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------------------------------- | --------------------------------------- | | ---------------------- | --------------------- |
| Promise&lt;boolean&gt; | Promise对象。返回当前设置是否成功。 | | Promise&lt;boolean&gt; | Promise对象。返回当前设置是否成功。 |
**示例：** **示例：**
...@@ -103,14 +103,14 @@ setTargetBundleName(targetNames: Array\<string>): Promise\<boolean>; ...@@ -103,14 +103,14 @@ setTargetBundleName(targetNames: Array\<string>): Promise\<boolean>;
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 说明 | | 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ | | ----------- | ------------------- | ---- | -------- |
| targetNames | Array&lt;string&gt; | 是 | 关注的目标包名。 | | targetNames | Array&lt;string&gt; | 是 | 关注的目标包名。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------------------------------- | --------------------------------------- | | ---------------------- | --------------------- |
| Promise&lt;boolean&gt; | Promise对象。返回当前设置是否成功。 | | Promise&lt;boolean&gt; | Promise对象。返回当前设置是否成功。 |
**示例：** **示例：**
...@@ -129,14 +129,14 @@ getFocusElement(isAccessibilityFocus?: boolean): Promise\<AccessibilityElement>; ...@@ -129,14 +129,14 @@ getFocusElement(isAccessibilityFocus?: boolean): Promise\<AccessibilityElement>;
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 说明 | | 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ | | -------------------- | ------- | ---- | ------------------- |
| isAccessibilityFocus | boolean | 否 | 获取的是否是无障碍焦点元素，默认为否。 | | isAccessibilityFocus | boolean | 否 | 获取的是否是无障碍焦点元素，默认为否。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------------------------------- | --------------------------------------- | | ----------------------------------- | ---------------------- |
| Promise&lt;AccessibilityElement&gt; | Promise对象。返回当前对应的焦点元素。 | | Promise&lt;AccessibilityElement&gt; | Promise对象。返回当前对应的焦点元素。 |
**示例：** **示例：**
...@@ -157,14 +157,14 @@ getWindowRootElement(windowId?: number): Promise\<AccessibilityElement>; ...@@ -157,14 +157,14 @@ getWindowRootElement(windowId?: number): Promise\<AccessibilityElement>;
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 说明 | | 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ | | -------- | ------ | ---- | --------------------------- |
| windowId | number | 否 | 指定获取根节点元素的窗口，未指定则从当前活跃窗口获取。 | | windowId | number | 否 | 指定获取根节点元素的窗口，未指定则从当前活跃窗口获取。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------------------------------- | --------------------------------------- | | ----------------------------------- | ----------------------- |
| Promise&lt;AccessibilityElement&gt; | Promise对象。返回当前对应的根节点元素。 | | Promise&lt;AccessibilityElement&gt; | Promise对象。返回当前对应的根节点元素。 |
**示例：** **示例：**
...@@ -185,14 +185,14 @@ getWindows(displayId?: number): Promise<Array\<AccessibilityElement>>; ...@@ -185,14 +185,14 @@ getWindows(displayId?: number): Promise<Array\<AccessibilityElement>>;
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 说明 | | 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ | | --------- | ------ | ---- | ------------------------- |
| displayId | number | 否 | 指定获取窗口信息的屏幕，未指定则从默认主屏幕获取。 | | displayId | number | 否 | 指定获取窗口信息的屏幕，未指定则从默认主屏幕获取。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------------------------------- | --------------------------------------- | | ---------------------------------------- | ------------------------ |
| Promise&lt;Array&lt;AccessibilityElement&gt;&gt; | Promise对象。返回当前对应的窗口列表信息。 | | Promise&lt;Array&lt;AccessibilityElement&gt;&gt; | Promise对象。返回当前对应的窗口列表信息。 |
**示例：** **示例：**
...@@ -213,15 +213,15 @@ gestureInject(gesturePath: GesturePath, listener: Callback\<boolean>): Promise\< ...@@ -213,15 +213,15 @@ gestureInject(gesturePath: GesturePath, listener: Callback\<boolean>): Promise\<
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 说明 | | 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ | | ----------- | ---------------------------------------- | ---- | -------------- |
| gesturePath | [GesturePath](js-apis-application-AccessibilityExtensionAbility.md#GesturePath) | 是 | 表示手势的路径信息。 | | gesturePath | [GesturePath](js-apis-application-AccessibilityExtensionAbility.md#GesturePath) | 是 | 表示手势的路径信息。 |
| listener | Callback&lt;boolean&gt; | 是 | 表示注入手势执行结果的回调。 | | listener | Callback&lt;boolean&gt; | 是 | 表示注入手势执行结果的回调。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------------------------------- | --------------------------------------- | | ---------------------- | ---------------------- |
| Promise&lt;boolean&gt; | Promise对象。返回注入手势的调用结果。 | | Promise&lt;boolean&gt; | Promise对象。返回注入手势的调用结果。 |
**示例：** **示例：**
......
zh-cn/application-dev/reference/apis/js-apis-application-AccessibilityExtensionAbility.md
浏览文件 @ 53e5ce74
...@@ -11,7 +11,7 @@ ...@@ -11,7 +11,7 @@
## 导入模块 ## 导入模块
```ts ```ts
import AccessibilityExtensionAbility from './@ohos.application.AccessibilityExtensionAbility' import AccessibilityExtensionAbility from '@ohos.application.AccessibilityExtensionAbility'
``` ```
## AccessibilityEvent ## AccessibilityEvent
...@@ -22,11 +22,11 @@ import AccessibilityExtensionAbility from './@ohos.application.AccessibilityExte ...@@ -22,11 +22,11 @@ import AccessibilityExtensionAbility from './@ohos.application.AccessibilityExte
### 属性 ### 属性
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | --------- | ---------------------------------------- | ---- | ---- | ---------- |
| eventType | [EventType](js-apis-accessibility.md#EventType) \| [WindowUpdateType](js-apis-accessibility.md#WindowUpdateType) \| [TouchGuideType](touchguidetype) \| [GestureType](gesturetype) \| [PageUpdateType](pageupdatetype) | 是 | 否 | 具体事件类型。 | | eventType | [EventType](js-apis-accessibility.md#EventType) \| [WindowUpdateType](js-apis-accessibility.md#WindowUpdateType) \| [TouchGuideType](touchguidetype) \| [GestureType](gesturetype) \| [PageUpdateType](pageupdatetype) | 是 | 否 | 具体事件类型。 |
| target | AccessibilityElement | 是 | 否 | 发生事件的目标组件。 | | target | AccessibilityElement | 是 | 否 | 发生事件的目标组件。 |
| timeStamp | number | 是 | 否 | 事件时间戳。 | | timeStamp | number | 是 | 否 | 事件时间戳。 |
## GesturePath ## GesturePath
...@@ -36,10 +36,10 @@ import AccessibilityExtensionAbility from './@ohos.application.AccessibilityExte ...@@ -36,10 +36,10 @@ import AccessibilityExtensionAbility from './@ohos.application.AccessibilityExte
### 属性 ### 属性
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | ------------ | ---------------------------------------- | ---- | ---- | ------ |
| points | Array&lt;[GesturePoint](gesturepoint)&gt; | 是 | 是 | 手势。 | | points | Array&lt;[GesturePoint](gesturepoint)&gt; | 是 | 是 | 手势。 |
| durationTime | number | 是 | 是 | 手势总耗时。 | | durationTime | number | 是 | 是 | 手势总耗时。 |
### 方法 ### 方法
...@@ -51,9 +51,9 @@ constructor(durationTime: number) ...@@ -51,9 +51,9 @@ constructor(durationTime: number)
- 参数： - 参数：
| 参数名 | 参数类型 | 必填 | 说明 | | 参数名 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------------ | ------ | ---- | ------ |
| durationTime | number | 是 | 手势总耗时。 | | durationTime | number | 是 | 手势总耗时。 |
- 示例 - 示例
...@@ -69,10 +69,10 @@ constructor(durationTime: number) ...@@ -69,10 +69,10 @@ constructor(durationTime: number)
### 属性 ### 属性
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | --------- | ------ | ---- | ---- | ------- |
| positionX | number | 是 | 是 | 触摸点X坐标。 | | positionX | number | 是 | 是 | 触摸点X坐标。 |
| positionY | number | 是 | 是 | 触摸点Y坐标。 | | positionY | number | 是 | 是 | 触摸点Y坐标。 |
### 方法 ### 方法
...@@ -84,10 +84,10 @@ constructor(positionX: number, positionY: number) ...@@ -84,10 +84,10 @@ constructor(positionX: number, positionY: number)
- 参数： - 参数：
| 参数名 | 参数类型 | 必填 | 说明 | | 参数名 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | --------- | ------ | ---- | ------- |
| positionX | number | 是 | 触摸点X坐标。 | | positionX | number | 是 | 触摸点X坐标。 |
| positionY | number | 是 | 触摸点Y坐标。 | | positionY | number | 是 | 触摸点Y坐标。 |
- 示例 - 示例
...@@ -101,24 +101,24 @@ constructor(positionX: number, positionY: number) ...@@ -101,24 +101,24 @@ constructor(positionX: number, positionY: number)
**系统能力**：以下各项对应的系统能力均为 SystemCapability.Barrierfree.Accessibility.Core **系统能力**：以下各项对应的系统能力均为 SystemCapability.Barrierfree.Accessibility.Core
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ------------- | ------------ |
| left | 表示向左的手势。 | | left | 表示向左的手势。 |
| leftThenRight | 表示先向左再向右的手势。 | | leftThenRight | 表示先向左再向右的手势。 |
| leftThenUp | 表示先向左再向上的手势。 | | leftThenUp | 表示先向左再向上的手势。 |
| leftThenDown | 表示先向左再向下的手势。 | | leftThenDown | 表示先向左再向下的手势。 |
| right | 表示向右的手势。 | | right | 表示向右的手势。 |
| rightThenLeft | 表示先向右再向左的手势。 | | rightThenLeft | 表示先向右再向左的手势。 |
| rightThenUp | 表示先向右再向上的手势。 | | rightThenUp | 表示先向右再向上的手势。 |
| rightThenDown | 表示先向右再向下的手势。 | | rightThenDown | 表示先向右再向下的手势。 |
| up | 表示向上的手势。 | | up | 表示向上的手势。 |
| upThenLeft | 表示先向上再向左的手势。 | | upThenLeft | 表示先向上再向左的手势。 |
| upThenRight | 表示先向上再向右的手势。 | | upThenRight | 表示先向上再向右的手势。 |
| upThenDown | 表示先向上再向下的手势。 | | upThenDown | 表示先向上再向下的手势。 |
| down | 表示向下的手势。 | | down | 表示向下的手势。 |
| downThenLeft | 表示先向下再向左的手势。 | | downThenLeft | 表示先向下再向左的手势。 |
| downThenRight | 表示先向下再向右的手势。 | | downThenRight | 表示先向下再向右的手势。 |
| downThenUp | 表示先向下再向上的手势。 | | downThenUp | 表示先向下再向上的手势。 |
## PageUpdateType ## PageUpdateType
...@@ -126,10 +126,10 @@ constructor(positionX: number, positionY: number) ...@@ -126,10 +126,10 @@ constructor(positionX: number, positionY: number)
**系统能力**：以下各项对应的系统能力均为 SystemCapability.Barrierfree.Accessibility.Core **系统能力**：以下各项对应的系统能力均为 SystemCapability.Barrierfree.Accessibility.Core
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ----------------- | --------- |
| pageContentUpdate | 表示页面内容刷新。 | | pageContentUpdate | 表示页面内容刷新。 |
| pageStateUpdate | 表示页面状态刷新。 | | pageStateUpdate | 表示页面状态刷新。 |
## TouchGuideType ## TouchGuideType
...@@ -137,10 +137,10 @@ constructor(positionX: number, positionY: number) ...@@ -137,10 +137,10 @@ constructor(positionX: number, positionY: number)
**系统能力**：以下各项对应的系统能力均为 SystemCapability.Barrierfree.Accessibility.Core **系统能力**：以下各项对应的系统能力均为 SystemCapability.Barrierfree.Accessibility.Core
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ---------- | ------------ |
| touchBegin | 表示触摸浏览时开始触摸。 | | touchBegin | 表示触摸浏览时开始触摸。 |
| touchEnd | 表示触摸浏览时结束触摸。 | | touchEnd | 表示触摸浏览时结束触摸。 |
## AccessibilityExtensionAbility.onConnect ## AccessibilityExtensionAbility.onConnect
...@@ -192,9 +192,9 @@ onAccessibilityEvent(event: AccessibilityEvent): void; ...@@ -192,9 +192,9 @@ onAccessibilityEvent(event: AccessibilityEvent): void;
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 说明 | | 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ | | ----- | ---------------------------------------- | ---- | --------------- |
| event | [AccessibilityEvent](accessibilityevent) | 是 | 无障碍事件回调函数。无返回值。 | | event | [AccessibilityEvent](accessibilityevent) | 是 | 无障碍事件回调函数。无返回值。 |
**示例：** **示例：**
...@@ -217,9 +217,9 @@ onKeyEvent(keyEvent: inputEventClient.KeyEvent): boolean; ...@@ -217,9 +217,9 @@ onKeyEvent(keyEvent: inputEventClient.KeyEvent): boolean;
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 说明 | | 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ | | -------- | ---------------------------------------- | ---- | ----------------------- |
| keyEvent | [KeyEvent](js-apis-inputeventclient.md#KeyEvent) | 是 | 按键事件回调函数。返回true表示拦截此按键。 | | keyEvent | [KeyEvent](js-apis-inputeventclient.md#KeyEvent) | 是 | 按键事件回调函数。返回true表示拦截此按键。 |
**示例：** **示例：**
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或