You need to sign in or sign up before continuing.
未验证 提交 d7e629a1 编写于 作者: O openharmony_ci 提交者: Gitee

!9954 修复接口文档不一致问题和示例代码自动化问题

Merge pull request !9954 from zaki/master
...@@ -27,7 +27,7 @@ class MainAbility extends AccessibilityExtensionAbility { ...@@ -27,7 +27,7 @@ class MainAbility extends AccessibilityExtensionAbility {
表示查询下一焦点元素的方向。 表示查询下一焦点元素的方向。
**系统能力**:以下各项对应的系统能力均为 SystemCapability.Barrierfree.Accessibility.Core **系统能力**:以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core
| 名称 | 描述 | | 名称 | 描述 |
| -------- | ------- | | -------- | ------- |
...@@ -42,7 +42,7 @@ class MainAbility extends AccessibilityExtensionAbility { ...@@ -42,7 +42,7 @@ class MainAbility extends AccessibilityExtensionAbility {
表示查询焦点元素的类型。 表示查询焦点元素的类型。
**系统能力**:以下各项对应的系统能力均为 SystemCapability.Barrierfree.Accessibility.Core **系统能力**:以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core
| 名称 | 描述 | | 名称 | 描述 |
| ------------- | ----------- | | ------------- | ----------- |
...@@ -53,7 +53,7 @@ class MainAbility extends AccessibilityExtensionAbility { ...@@ -53,7 +53,7 @@ class MainAbility extends AccessibilityExtensionAbility {
表示矩形区域。 表示矩形区域。
**系统能力**:以下各项对应的系统能力均为 SystemCapability.Barrierfree.Accessibility.Core **系统能力**:以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ---- | ---- | --------- | | ------ | ------ | ---- | ---- | --------- |
...@@ -66,7 +66,7 @@ class MainAbility extends AccessibilityExtensionAbility { ...@@ -66,7 +66,7 @@ class MainAbility extends AccessibilityExtensionAbility {
表示窗口的类型。 表示窗口的类型。
**系统能力**:以下各项对应的系统能力均为 SystemCapability.Barrierfree.Accessibility.Core **系统能力**:以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core
| 名称 | 描述 | | 名称 | 描述 |
| ----------- | --------- | | ----------- | --------- |
...@@ -185,7 +185,7 @@ this.context.getWindows().then(windows => { ...@@ -185,7 +185,7 @@ this.context.getWindows().then(windows => {
## AccessibilityExtensionContext.injectGesture ## AccessibilityExtensionContext.injectGesture
injectGesture(gesturePath: GesturePath, listener: Callback\<boolean>): Promise\<void> injectGesture(gesturePath: GesturePath, callback: AsyncCallback\<void>): void
注入手势。 注入手势。
...@@ -196,13 +196,7 @@ injectGesture(gesturePath: GesturePath, listener: Callback\<boolean>): Promise\< ...@@ -196,13 +196,7 @@ injectGesture(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; | 是 | 表示注入手势执行结果的回调。 | | callback | AsyncCallback&lt;void&gt; | 是 | 表示注入手势执行结果的回调。 |
**返回值:**
| 类型 | 说明 |
| ---------------------- | ---------------------- |
| Promise&lt;boolean&gt; | Promise对象。返回注入手势的调用结果。 |
**示例:** **示例:**
...@@ -218,7 +212,7 @@ this.context.gestureInject(gesturePath, (result) => { ...@@ -218,7 +212,7 @@ this.context.gestureInject(gesturePath, (result) => {
``` ```
## AccessibilityElement.attributeNames ## AccessibilityElement.attributeNames
attributeNames\<T extends keyof ElementAttributeValues>(): Promise\<Array<T>>; attributeNames\<T extends keyof ElementAttributeValues>(): Promise\<Array\<T>>;
获取节点元素的所有属性名称。 获取节点元素的所有属性名称。
...@@ -283,7 +277,7 @@ try { ...@@ -283,7 +277,7 @@ try {
## AccessibilityElement.actionNames ## AccessibilityElement.actionNames
actionNames(): Promise\<Array<string>>; actionNames(): Promise\<Array\<string>>;
获取节点元素支持的所有操作名称。 获取节点元素支持的所有操作名称。
...@@ -349,7 +343,7 @@ try { ...@@ -349,7 +343,7 @@ try {
## AccessibilityElement.findElement ## AccessibilityElement.findElement
findElement(type: 'content', condition: string): Promise\<Array<AccessibilityElement>>; findElement(type: 'content', condition: string): Promise\<Array\<AccessibilityElement>>;
查询节点元素的指定内容。 查询节点元素的指定内容。
......
...@@ -173,6 +173,7 @@ on(type: 'enableChange', callback: Callback&lt;boolean&gt;): void; ...@@ -173,6 +173,7 @@ on(type: 'enableChange', callback: Callback&lt;boolean&gt;): void;
- **示例:** - **示例:**
```typescript ```typescript
let captionsManager = accessibility.getCaptionsManager();
captionsManager.on('enableChange',(data) => { captionsManager.on('enableChange',(data) => {
console.info('success data:subscribeStateObserver : ' + JSON.stringify(data)) console.info('success data:subscribeStateObserver : ' + JSON.stringify(data))
}) })
...@@ -194,6 +195,7 @@ on(type: 'styleChange', callback: Callback&lt;CaptionsStyle&gt;): void; ...@@ -194,6 +195,7 @@ on(type: 'styleChange', callback: Callback&lt;CaptionsStyle&gt;): void;
- **示例:** - **示例:**
```typescript ```typescript
let captionsManager = accessibility.getCaptionsManager();
captionsManager.on('styleChange',(data) => { captionsManager.on('styleChange',(data) => {
console.info('success data:subscribeStateObserver : ' + JSON.stringify(data)) console.info('success data:subscribeStateObserver : ' + JSON.stringify(data))
}) })
...@@ -215,6 +217,7 @@ off(type: 'enableChange', callback?: Callback&lt;boolean&gt;): void; ...@@ -215,6 +217,7 @@ off(type: 'enableChange', callback?: Callback&lt;boolean&gt;): void;
- **示例:** - **示例:**
```typescript ```typescript
let captionsManager = accessibility.getCaptionsManager();
captionsManager.off('enableChange') captionsManager.off('enableChange')
``` ```
...@@ -234,6 +237,7 @@ off(type: 'styleChange', callback?: Callback&lt;CaptionsStyle&gt;): void; ...@@ -234,6 +237,7 @@ off(type: 'styleChange', callback?: Callback&lt;CaptionsStyle&gt;): void;
- **示例:** - **示例:**
```typescript ```typescript
let captionsManager = accessibility.getCaptionsManager();
captionsManager.off('styleChange') captionsManager.off('styleChange')
``` ```
...@@ -361,11 +365,6 @@ getAbilityLists(abilityType: AbilityType, stateType: AbilityState): Promise&lt;A ...@@ -361,11 +365,6 @@ getAbilityLists(abilityType: AbilityType, stateType: AbilityState): Promise&lt;A
console.info(item.id); console.info(item.id);
console.info(item.name); console.info(item.name);
console.info(item.description); console.info(item.description);
console.info(item.abilityTypes);
console.info(item.eventTypes);
console.info(item.capabilities);
console.info(item.packageName);
console.info(item.filterBundleNames);
console.info(item.bundleName); console.info(item.bundleName);
} }
}).catch((error) => { }).catch((error) => {
...@@ -402,11 +401,6 @@ getAbilityLists(abilityType: AbilityType, stateType: AbilityState,callback: Asyn ...@@ -402,11 +401,6 @@ getAbilityLists(abilityType: AbilityType, stateType: AbilityState,callback: Asyn
console.info(item.id); console.info(item.id);
console.info(item.name); console.info(item.name);
console.info(item.description); console.info(item.description);
console.info(item.abilityTypes);
console.info(item.eventTypes);
console.info(item.capabilities);
console.info(item.packageName);
console.info(item.filterBundleNames);
console.info(item.bundleName); console.info(item.bundleName);
} }
}) })
...@@ -429,7 +423,7 @@ getCaptionsManager(): CaptionsManager ...@@ -429,7 +423,7 @@ getCaptionsManager(): CaptionsManager
- **示例:** - **示例:**
```typescript ```typescript
captionsManager = accessibility.getCaptionsManager() let captionsManager = accessibility.getCaptionsManager()
``` ```
## accessibility.on('accessibilityStateChange' | 'touchGuideStateChange') ## accessibility.on('accessibilityStateChange' | 'touchGuideStateChange')
...@@ -603,7 +597,12 @@ sendEvent(event: EventInfo): Promise&lt;void&gt; ...@@ -603,7 +597,12 @@ sendEvent(event: EventInfo): Promise&lt;void&gt;
- **示例:** - **示例:**
```typescript ```typescript
accessibility.sendEvent(this.eventInfo) let eventInfo : accessibility.EventInfo = {
type: 'focus',
bundleName: 'bundle',
triggerAction: 'focus'
}
accessibility.sendEvent(eventInfo)
.then((data) => { .then((data) => {
console.info('success data:sendEvent : ' + JSON.stringify(data)) console.info('success data:sendEvent : ' + JSON.stringify(data))
}).catch((error) => { }).catch((error) => {
...@@ -629,7 +628,12 @@ sendEvent(event: EventInfo, callback: AsyncCallback&lt;void&gt;): void ...@@ -629,7 +628,12 @@ sendEvent(event: EventInfo, callback: AsyncCallback&lt;void&gt;): void
- **示例:** - **示例:**
```typescript ```typescript
accessibility.sendEvent(this.eventInfo,(err, data) => { let eventInfo : accessibility.EventInfo = {
type: 'focus',
bundleName: 'bundle',
triggerAction: 'focus'
}
accessibility.sendEvent(eventInfo,(err, data) => {
if (err) { if (err) {
console.error('failed to sendEvent because ' + JSON.stringify(err)); console.error('failed to sendEvent because ' + JSON.stringify(err));
return; return;
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册