From 5a047c81ce47c9ecd565a6c8c695a5b2dd7e00a9 Mon Sep 17 00:00:00 2001 From: zaki Date: Fri, 23 Sep 2022 17:36:55 +0800 Subject: [PATCH] Fix the inconsistency of interface files Signed-off-by: zaki Change-Id: Id12d13e8d2e67257eae30461f3952adbf481039c --- ...js-apis-accessibility-extension-context.md | 199 +++++++++++++++--- 1 file changed, 169 insertions(+), 30 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-accessibility-extension-context.md b/zh-cn/application-dev/reference/apis/js-apis-accessibility-extension-context.md index d5bd800be9..5b928c9dea 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-accessibility-extension-context.md +++ b/zh-cn/application-dev/reference/apis/js-apis-accessibility-extension-context.md @@ -55,8 +55,6 @@ class MainAbility extends AccessibilityExtensionAbility { **系统能力**：以下各项对应的系统能力均为 SystemCapability.Barrierfree.Accessibility.Core -### 参数 - | 名称 | 参数类型 | 可读 | 可写 | 说明 | | ------ | ------ | ---- | ---- | --------- | | left | number | 是 | 否 | 矩形区域的左边界。 | @@ -75,35 +73,9 @@ class MainAbility extends AccessibilityExtensionAbility { | application | 表示应用窗口类型。 | | system | 表示系统窗口类型。 | -## AccessibilityExtensionContext.setEventTypeFilter - -setEventTypeFilter(type: Array): Promise\; - -设置关注的事件类型。 - -**系统能力：** SystemCapability.BarrierFree.Accessibility.Core - -**参数：** - -| 参数名 | 参数类型 | 必填 | 说明 | -| ---- | ---------------------------------------- | ---- | -------- | -| type | Array<[EventType](js-apis-accessibility.md#EventType)> | 是 | 关注的事件类型。 | - -**返回值：** - -| 类型 | 说明 | -| ---------------------- | --------------------- | -| Promise<boolean> | Promise对象。返回当前设置是否成功。 | - -**示例：** - -```ts -this.context.setEventTypeFilter(['click', 'longClick']); -``` - ## AccessibilityExtensionContext.setTargetBundleName -setTargetBundleName(targetNames: Array\): Promise\; +setTargetBundleName(targetNames: Array\): Promise\; 设置关注的事件类型。 @@ -213,7 +185,7 @@ this.context.getWindows().then(windows => { ## AccessibilityExtensionContext.injectGesture -injectGesture(gesturePath: GesturePath, listener: Callback\): Promise\): Promise\ 注入手势。 @@ -244,3 +216,170 @@ this.context.gestureInject(gesturePath, (result) => { console.info('gestureInject result: ' + result); }) ``` +## AccessibilityElement.attributeNames + +attributeNames\(): Promise\>; + +获取节点元素的所有属性名称。 + +**系统能力：** SystemCapability.BarrierFree.Accessibility.Core + +**返回值：** + +| 类型 | 说明 | +| ---------------------------------------- | ------------------------ | +| Promise<Array<T>> | Promise对象。返回获取元素所有属性名称的调用结果。 | + +**示例：** + +```ts +let accessibilityElement; +try { + accessibilityElement.attributeNames().then((values) => { + console.log("get attribute names success"); + }).catch((err) => { + console.log("get attribute names err: " + JSON.stringify(err)); + }); +} catch (e) { + console.log("An unexpected error occurred. Error:" + e); +} +``` + +## AccessibilityElement.attributeValue + +attributeValue\(attributeName: T): Promise\; + +根据属性名称获取属性值。 + +**系统能力：** SystemCapability.BarrierFree.Accessibility.Core + +**参数：** + +| 参数名 | 参数类型 | 必填 | 说明 | +| ----------- | ---------------------------------------- | ---- | -------------- | +| attributeName | T | 是 | 表示属性的名称。 | + +**返回值：** + +| 类型 | 说明 | +| ---------------------------------------- | ------------------------ | +| Promise<Array<ElementAttributeValues[T]>> | Promise对象。返回根据属性名称获取属性值的调用结果。 | + +**示例：** + +```ts +let accessibilityElement; +try { + let attributeName = 'name'; + accessibilityElement.attributeValue(attributeName).then((value) => { + console.log("get attribute value by name success"); + }).catch((err) => { + console.log("get attribute value by name err: " + JSON.stringify(err)); + }); +} catch (e) { + console.log("An unexpected error occurred. Error:" + e); +} +``` + +## AccessibilityElement.actionNames + +actionNames(): Promise\>; + +获取节点元素支持的所有操作名称。 + +**系统能力：** SystemCapability.BarrierFree.Accessibility.Core + +**返回值：** + +| 类型 | 说明 | +| ---------------------------------------- | ------------------------ | +| Promise<Array<string>> | Promise对象。返回获取节点元素支持的所有操作名称的调用结果。 | + +**示例：** + +```ts +let accessibilityElement; +try { + accessibilityElement.actionNames().then((values) => { + console.log("get action names success"); + }).catch((err) => { + console.log("get action names err: " + JSON.stringify(err)); + }); +} catch (e) { + console.log("An unexpected error occurred. Error:" + e); +} +``` + +## AccessibilityElement.performAction + +performAction(actionName: string, parameters?: object): Promise\; + +根据操作名称执行某个操作。 + +**系统能力：** SystemCapability.BarrierFree.Accessibility.Core + +**参数：** + +| 参数名 | 参数类型 | 必填 | 说明 | +| ----------- | ---------------------------------------- | ---- | -------------- | +| actionName | string | 是 | 表示属性的名称。 | +| parameters | object | 否 | 表示执行操作时所需要的参数。 | + +**返回值：** + +| 类型 | 说明 | +| ---------------------------------------- | ------------------------ | +| Promise<Array<boolean>> | Promise对象。返回获取元素所有属性名的调用结果。 | + +**示例：** + +```ts +let accessibilityElement; +try { + + accessibilityElement.performAction('action').then((result) => { + console.info('perform action result: ' + result); + }).catch((err) => { + console.log("perform action err: " + JSON.stringify(err)); + }); +} catch (e) { + console.log("An unexpected error occurred. Error:" + e); +} +``` + +## AccessibilityElement.findElement + +findElement(type: 'content', condition: string): Promise\>; + +查询节点元素的指定内容。 + +**系统能力：** SystemCapability.BarrierFree.Accessibility.Core + +**参数：** + +| 参数名 | 参数类型 | 必填 | 说明 | +| ----------- | ---------------------------------------- | ---- | -------------- | +| type | string | 是 | 固定为'content',表示查找的类型为节点元素内容。 | +| condition | string | 是 | 表示查找的条件。 | + +**返回值：** + +| 类型 | 说明 | +| ---------------------------------------- | ------------------------ | +| Promise<Array<T>> | Promise对象。返回获取元素所有属性名的调用结果。 | + +**示例：** + +```ts +let accessibilityElement; +try { + let condition = 'keyword'; + accessibilityElement.findElement('content', condition).then((values) => { + console.log("find element success"); + }).catch((err) => { + console.log("find element err: " + JSON.stringify(err)); + }); +} catch (e) { + console.log("An unexpected error occurred. Error:" + e); +} +``` -- GitLab