提交 3d3c18d5 编写于 作者: H HelloCrease

update docs

Signed-off-by: NHelloCrease <lian15@huawei.com>
上级 0c252a6a
...@@ -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
...@@ -22,7 +22,7 @@ import AccessibilityExtensionAbility from './@ohos.application.AccessibilityExte ...@@ -22,7 +22,7 @@ import AccessibilityExtensionAbility from './@ohos.application.AccessibilityExte
**系统能力**:以下各项对应的系统能力均为 SystemCapability.Barrierfree.Accessibility.Core **系统能力**:以下各项对应的系统能力均为 SystemCapability.Barrierfree.Accessibility.Core
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------- | ------- |
| up | 表示向上查询。 | | up | 表示向上查询。 |
| down | 表示向上查询。 | | down | 表示向上查询。 |
| left | 表示向左查询。 | | left | 表示向左查询。 |
...@@ -37,7 +37,7 @@ import AccessibilityExtensionAbility from './@ohos.application.AccessibilityExte ...@@ -37,7 +37,7 @@ import AccessibilityExtensionAbility from './@ohos.application.AccessibilityExte
**系统能力**:以下各项对应的系统能力均为 SystemCapability.Barrierfree.Accessibility.Core **系统能力**:以下各项对应的系统能力均为 SystemCapability.Barrierfree.Accessibility.Core
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ------------- | ----------- |
| accessibility | 表示无障碍的焦点类型。 | | accessibility | 表示无障碍的焦点类型。 |
| normal | 表示普通的焦点类型。 | | normal | 表示普通的焦点类型。 |
...@@ -50,7 +50,7 @@ import AccessibilityExtensionAbility from './@ohos.application.AccessibilityExte ...@@ -50,7 +50,7 @@ import AccessibilityExtensionAbility from './@ohos.application.AccessibilityExte
### 参数 ### 参数
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ------ | -------- | ---- | ---- | ------------------ | | ------ | ------ | ---- | ---- | --------- |
| left | number | 是 | 否 | 矩形区域的左边界。 | | left | number | 是 | 否 | 矩形区域的左边界。 |
| top | number | 是 | 否 | 矩形区域的上边界。 | | top | number | 是 | 否 | 矩形区域的上边界。 |
| width | number | 是 | 否 | 矩形区域的宽度。 | | width | number | 是 | 否 | 矩形区域的宽度。 |
...@@ -63,7 +63,7 @@ import AccessibilityExtensionAbility from './@ohos.application.AccessibilityExte ...@@ -63,7 +63,7 @@ import AccessibilityExtensionAbility from './@ohos.application.AccessibilityExte
**系统能力**:以下各项对应的系统能力均为 SystemCapability.Barrierfree.Accessibility.Core **系统能力**:以下各项对应的系统能力均为 SystemCapability.Barrierfree.Accessibility.Core
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ----------- | --------- |
| application | 表示应用窗口类型。 | | application | 表示应用窗口类型。 |
| system | 表示系统窗口类型。 | | system | 表示系统窗口类型。 |
...@@ -78,13 +78,13 @@ setEventTypeFilter(type: Array<accessibility.EventType>): Promise\<boolean>; ...@@ -78,13 +78,13 @@ 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对象。返回当前设置是否成功。 |
**示例:** **示例:**
...@@ -104,13 +104,13 @@ setTargetBundleName(targetNames: Array\<string>): Promise\<boolean>; ...@@ -104,13 +104,13 @@ 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对象。返回当前设置是否成功。 |
**示例:** **示例:**
...@@ -130,13 +130,13 @@ getFocusElement(isAccessibilityFocus?: boolean): Promise\<AccessibilityElement>; ...@@ -130,13 +130,13 @@ getFocusElement(isAccessibilityFocus?: boolean): Promise\<AccessibilityElement>;
**参数:** **参数:**
| 参数名 | 参数类型 | 必填 | 说明 | | 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ | | -------------------- | ------- | ---- | ------------------- |
| isAccessibilityFocus | boolean | 否 | 获取的是否是无障碍焦点元素,默认为否。 | | isAccessibilityFocus | boolean | 否 | 获取的是否是无障碍焦点元素,默认为否。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------------------------------- | --------------------------------------- | | ----------------------------------- | ---------------------- |
| Promise&lt;AccessibilityElement&gt; | Promise对象。返回当前对应的焦点元素。 | | Promise&lt;AccessibilityElement&gt; | Promise对象。返回当前对应的焦点元素。 |
**示例:** **示例:**
...@@ -158,13 +158,13 @@ getWindowRootElement(windowId?: number): Promise\<AccessibilityElement>; ...@@ -158,13 +158,13 @@ getWindowRootElement(windowId?: number): Promise\<AccessibilityElement>;
**参数:** **参数:**
| 参数名 | 参数类型 | 必填 | 说明 | | 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ | | -------- | ------ | ---- | --------------------------- |
| windowId | number | 否 | 指定获取根节点元素的窗口,未指定则从当前活跃窗口获取。 | | windowId | number | 否 | 指定获取根节点元素的窗口,未指定则从当前活跃窗口获取。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------------------------------- | --------------------------------------- | | ----------------------------------- | ----------------------- |
| Promise&lt;AccessibilityElement&gt; | Promise对象。返回当前对应的根节点元素。 | | Promise&lt;AccessibilityElement&gt; | Promise对象。返回当前对应的根节点元素。 |
**示例:** **示例:**
...@@ -186,13 +186,13 @@ getWindows(displayId?: number): Promise<Array\<AccessibilityElement>>; ...@@ -186,13 +186,13 @@ 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对象。返回当前对应的窗口列表信息。 |
**示例:** **示例:**
...@@ -214,14 +214,14 @@ gestureInject(gesturePath: GesturePath, listener: Callback\<boolean>): Promise\< ...@@ -214,14 +214,14 @@ 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对象。返回注入手势的调用结果。 |
**示例:** **示例:**
......
...@@ -11,7 +11,7 @@ ...@@ -11,7 +11,7 @@
## 导入模块 ## 导入模块
```ts ```ts
import AccessibilityExtensionAbility from './@ohos.application.AccessibilityExtensionAbility' import AccessibilityExtensionAbility from '@ohos.application.AccessibilityExtensionAbility'
``` ```
## AccessibilityEvent ## AccessibilityEvent
...@@ -23,7 +23,7 @@ import AccessibilityExtensionAbility from './@ohos.application.AccessibilityExte ...@@ -23,7 +23,7 @@ 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 | 是 | 否 | 事件时间戳。 |
...@@ -37,7 +37,7 @@ import AccessibilityExtensionAbility from './@ohos.application.AccessibilityExte ...@@ -37,7 +37,7 @@ import AccessibilityExtensionAbility from './@ohos.application.AccessibilityExte
### 属性 ### 属性
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | ------------ | ---------------------------------------- | ---- | ---- | ------ |
| points | Array&lt;[GesturePoint](gesturepoint)&gt; | 是 | 是 | 手势。 | | points | Array&lt;[GesturePoint](gesturepoint)&gt; | 是 | 是 | 手势。 |
| durationTime | number | 是 | 是 | 手势总耗时。 | | durationTime | number | 是 | 是 | 手势总耗时。 |
...@@ -52,7 +52,7 @@ constructor(durationTime: number) ...@@ -52,7 +52,7 @@ constructor(durationTime: number)
- 参数: - 参数:
| 参数名 | 参数类型 | 必填 | 说明 | | 参数名 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------------ | ------ | ---- | ------ |
| durationTime | number | 是 | 手势总耗时。 | | durationTime | number | 是 | 手势总耗时。 |
- 示例 - 示例
...@@ -70,7 +70,7 @@ constructor(durationTime: number) ...@@ -70,7 +70,7 @@ constructor(durationTime: number)
### 属性 ### 属性
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | --------- | ------ | ---- | ---- | ------- |
| positionX | number | 是 | 是 | 触摸点X坐标。 | | positionX | number | 是 | 是 | 触摸点X坐标。 |
| positionY | number | 是 | 是 | 触摸点Y坐标。 | | positionY | number | 是 | 是 | 触摸点Y坐标。 |
...@@ -85,7 +85,7 @@ constructor(positionX: number, positionY: number) ...@@ -85,7 +85,7 @@ constructor(positionX: number, positionY: number)
- 参数: - 参数:
| 参数名 | 参数类型 | 必填 | 说明 | | 参数名 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | --------- | ------ | ---- | ------- |
| positionX | number | 是 | 触摸点X坐标。 | | positionX | number | 是 | 触摸点X坐标。 |
| positionY | number | 是 | 触摸点Y坐标。 | | positionY | number | 是 | 触摸点Y坐标。 |
...@@ -102,7 +102,7 @@ constructor(positionX: number, positionY: number) ...@@ -102,7 +102,7 @@ constructor(positionX: number, positionY: number)
**系统能力**:以下各项对应的系统能力均为 SystemCapability.Barrierfree.Accessibility.Core **系统能力**:以下各项对应的系统能力均为 SystemCapability.Barrierfree.Accessibility.Core
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ------------- | ------------ |
| left | 表示向左的手势。 | | left | 表示向左的手势。 |
| leftThenRight | 表示先向左再向右的手势。 | | leftThenRight | 表示先向左再向右的手势。 |
| leftThenUp | 表示先向左再向上的手势。 | | leftThenUp | 表示先向左再向上的手势。 |
...@@ -127,7 +127,7 @@ constructor(positionX: number, positionY: number) ...@@ -127,7 +127,7 @@ constructor(positionX: number, positionY: number)
**系统能力**:以下各项对应的系统能力均为 SystemCapability.Barrierfree.Accessibility.Core **系统能力**:以下各项对应的系统能力均为 SystemCapability.Barrierfree.Accessibility.Core
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ----------------- | --------- |
| pageContentUpdate | 表示页面内容刷新。 | | pageContentUpdate | 表示页面内容刷新。 |
| pageStateUpdate | 表示页面状态刷新。 | | pageStateUpdate | 表示页面状态刷新。 |
...@@ -138,7 +138,7 @@ constructor(positionX: number, positionY: number) ...@@ -138,7 +138,7 @@ constructor(positionX: number, positionY: number)
**系统能力**:以下各项对应的系统能力均为 SystemCapability.Barrierfree.Accessibility.Core **系统能力**:以下各项对应的系统能力均为 SystemCapability.Barrierfree.Accessibility.Core
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ---------- | ------------ |
| touchBegin | 表示触摸浏览时开始触摸。 | | touchBegin | 表示触摸浏览时开始触摸。 |
| touchEnd | 表示触摸浏览时结束触摸。 | | touchEnd | 表示触摸浏览时结束触摸。 |
...@@ -193,7 +193,7 @@ onAccessibilityEvent(event: AccessibilityEvent): void; ...@@ -193,7 +193,7 @@ onAccessibilityEvent(event: AccessibilityEvent): void;
**参数:** **参数:**
| 参数名 | 参数类型 | 必填 | 说明 | | 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ | | ----- | ---------------------------------------- | ---- | --------------- |
| event | [AccessibilityEvent](accessibilityevent) | 是 | 无障碍事件回调函数。无返回值。 | | event | [AccessibilityEvent](accessibilityevent) | 是 | 无障碍事件回调函数。无返回值。 |
**示例:** **示例:**
...@@ -218,7 +218,7 @@ onKeyEvent(keyEvent: inputEventClient.KeyEvent): boolean; ...@@ -218,7 +218,7 @@ onKeyEvent(keyEvent: inputEventClient.KeyEvent): boolean;
**参数:** **参数:**
| 参数名 | 参数类型 | 必填 | 说明 | | 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ | | -------- | ---------------------------------------- | ---- | ----------------------- |
| keyEvent | [KeyEvent](js-apis-inputeventclient.md#KeyEvent) | 是 | 按键事件回调函数。返回true表示拦截此按键。 | | keyEvent | [KeyEvent](js-apis-inputeventclient.md#KeyEvent) | 是 | 按键事件回调函数。返回true表示拦截此按键。 |
**示例:** **示例:**
......
...@@ -33,7 +33,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback&lt;DeviceManager ...@@ -33,7 +33,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback&lt;DeviceManager
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---------- | ---------------------------------------- | ---- | ------------------------------------ |
| bundleName | string | 是 | 指示应用程序的包名。 | | bundleName | string | 是 | 指示应用程序的包名。 |
| callback | AsyncCallback&lt;[DeviceManager](#devicemanager)&gt; | 是 | DeviceManager实例创建时调用的回调,返回设备管理器对象实例。 | | callback | AsyncCallback&lt;[DeviceManager](#devicemanager)&gt; | 是 | DeviceManager实例创建时调用的回调,返回设备管理器对象实例。 |
...@@ -45,7 +45,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback&lt;DeviceManager ...@@ -45,7 +45,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback&lt;DeviceManager
return; return;
} }
console.info("createDeviceManager success"); console.info("createDeviceManager success");
this.dmInstance = data; let dmInstance = data;
}); });
``` ```
...@@ -56,7 +56,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback&lt;DeviceManager ...@@ -56,7 +56,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback&lt;DeviceManager
**系统能力**:以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager **系统能力**:以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | -------- | -------- | -------- | | ---------------------- | ------------------------- | ---- | -------- |
| deviceId | string | 是 | 设备的唯一标识。 | | deviceId | string | 是 | 设备的唯一标识。 |
| deviceName | string | 是 | 设备名称。 | | deviceName | string | 是 | 设备名称。 |
| deviceType | [DeviceType](#devicetype) | 是 | 设备类型。 | | deviceType | [DeviceType](#devicetype) | 是 | 设备类型。 |
...@@ -70,7 +70,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback&lt;DeviceManager ...@@ -70,7 +70,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback&lt;DeviceManager
**系统能力**:以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager **系统能力**:以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| -------- | -------- | -------- | | ------------ | ---- | ---- |
| SPEAKER | 0x0A | 智能音箱 | | SPEAKER | 0x0A | 智能音箱 |
| PHONE | 0x0E | 手机 | | PHONE | 0x0E | 手机 |
| TABLET | 0x11 | 平板 | | TABLET | 0x11 | 平板 |
...@@ -87,7 +87,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback&lt;DeviceManager ...@@ -87,7 +87,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback&lt;DeviceManager
**系统能力**:以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager **系统能力**:以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| -------- | -------- | -------- | | ------- | ---- | --------------- |
| ONLINE | 0 | 设备上线。 | | ONLINE | 0 | 设备上线。 |
| READY | 1 | 设备就绪,设备信息同步已完成。 | | READY | 1 | 设备就绪,设备信息同步已完成。 |
| OFFLINE | 2 | 设备下线。 | | OFFLINE | 2 | 设备下线。 |
...@@ -100,7 +100,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback&lt;DeviceManager ...@@ -100,7 +100,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback&lt;DeviceManager
**系统能力**:以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager **系统能力**:以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | -------- | -------- | -------- | | ------------- | --------------------------------- | ---- | ----------------- |
| subscribeId | number | 是 | 发现标识,用于标识不同的发现周期。 | | subscribeId | number | 是 | 发现标识,用于标识不同的发现周期。 |
| mode | [DiscoverMode ](#discovermode) | 否 | 发现模式。 | | mode | [DiscoverMode ](#discovermode) | 否 | 发现模式。 |
| medium | [ExchangeMedium](#exchangemedium) | 否 | 发现类型。 | | medium | [ExchangeMedium](#exchangemedium) | 否 | 发现类型。 |
...@@ -117,7 +117,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback&lt;DeviceManager ...@@ -117,7 +117,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback&lt;DeviceManager
**系统能力**:以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager **系统能力**:以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| -------- | -------- | -------- | | --------------------- | ---- | ----- |
| DISCOVER_MODE_PASSIVE | 0x55 | 被动模式。 | | DISCOVER_MODE_PASSIVE | 0x55 | 被动模式。 |
| DISCOVER_MODE_ACTIVE | 0xAA | 主动模式。 | | DISCOVER_MODE_ACTIVE | 0xAA | 主动模式。 |
...@@ -129,7 +129,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback&lt;DeviceManager ...@@ -129,7 +129,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback&lt;DeviceManager
**系统能力**:以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager **系统能力**:以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| -------- | -------- | -------- | | ---- | ---- | --------- |
| AUTO | 0 | 自动发现类型。 | | AUTO | 0 | 自动发现类型。 |
| BLE | 1 | 蓝牙发现类型。 | | BLE | 1 | 蓝牙发现类型。 |
| COAP | 2 | WiFi发现类型。 | | COAP | 2 | WiFi发现类型。 |
...@@ -142,7 +142,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback&lt;DeviceManager ...@@ -142,7 +142,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback&lt;DeviceManager
**系统能力**:以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager **系统能力**:以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| -------- | -------- | -------- | | ---------- | ---- | ----- |
| LOW | 0 | 低频率。 | | LOW | 0 | 低频率。 |
| MID | 1 | 中频率。 | | MID | 1 | 中频率。 |
| HIGH | 2 | 高频率。 | | HIGH | 2 | 高频率。 |
...@@ -156,7 +156,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback&lt;DeviceManager ...@@ -156,7 +156,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback&lt;DeviceManager
**系统能力**:以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager **系统能力**:以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| -------- | -------- | -------- | | ------------------------- | ---- | -------------- |
| SUBSCRIBE_CAPABILITY_DDMP | 0 | DDMP能力,后续会被废弃。 | | SUBSCRIBE_CAPABILITY_DDMP | 0 | DDMP能力,后续会被废弃。 |
| SUBSCRIBE_CAPABILITY_OSD | 1 | OSD能力。 | | SUBSCRIBE_CAPABILITY_OSD | 1 | OSD能力。 |
...@@ -168,7 +168,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback&lt;DeviceManager ...@@ -168,7 +168,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback&lt;DeviceManager
**系统能力**:以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager **系统能力**:以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | -------- | -------- | -------- | | --------- | -------------------- | ---- | ---------- |
| authType | number | 是 | 认证类型。 | | authType | number | 是 | 认证类型。 |
| extraInfo | {[key:string] : any} | 否 | 认证参数可扩展字段。 | | extraInfo | {[key:string] : any} | 否 | 认证参数可扩展字段。 |
...@@ -179,7 +179,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback&lt;DeviceManager ...@@ -179,7 +179,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback&lt;DeviceManager
**系统能力**:以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager **系统能力**:以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | -------- | -------- | -------- | | --------- | -------------------- | ---- | ---------- |
| authType | number | 是 | 认证类型。 | | authType | number | 是 | 认证类型。 |
| token | number | 是 | 认证Token。 | | token | number | 是 | 认证Token。 |
| extraInfo | {[key:string] : any} | 否 | 认证信息可扩展字段。 | | extraInfo | {[key:string] : any} | 否 | 认证信息可扩展字段。 |
...@@ -214,7 +214,7 @@ getTrustedDeviceListSync(): Array&lt;DeviceInfo&gt; ...@@ -214,7 +214,7 @@ getTrustedDeviceListSync(): Array&lt;DeviceInfo&gt;
- 返回值: - 返回值:
| 名称 | 说明 | | 名称 | 说明 |
| -------- | -------- | | -------------------------------------- | --------- |
| Array&lt;[DeviceInfo](#deviceinfo)&gt; | 返回可信设备列表。 | | Array&lt;[DeviceInfo](#deviceinfo)&gt; | 返回可信设备列表。 |
- 示例: - 示例:
...@@ -233,7 +233,7 @@ getTrustedDeviceList(callback:AsyncCallback&lt;Array&lt;DeviceInfo&gt;&gt;): voi ...@@ -233,7 +233,7 @@ getTrustedDeviceList(callback:AsyncCallback&lt;Array&lt;DeviceInfo&gt;&gt;): voi
- 参数: - 参数:
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | --------------------- |
| callback | AsyncCallback&lt;Array&lt;[DeviceInfo](#deviceinfo)&gt;&gt; | 是 | 获取所有可信设备列表的回调,返回设备信息。 | | callback | AsyncCallback&lt;Array&lt;[DeviceInfo](#deviceinfo)&gt;&gt; | 是 | 获取所有可信设备列表的回调,返回设备信息。 |
- 示例: - 示例:
...@@ -255,7 +255,7 @@ getTrustedDeviceList(): Promise&lt;Array&lt;DeviceInfo&gt;&gt; ...@@ -255,7 +255,7 @@ getTrustedDeviceList(): Promise&lt;Array&lt;DeviceInfo&gt;&gt;
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ---------------------------------------- | --------------------- |
| Promise&lt;Array&lt;[DeviceInfo](#deviceinfo)&gt;&gt; | Promise实例,用于获取异步返回结果。 | | Promise&lt;Array&lt;[DeviceInfo](#deviceinfo)&gt;&gt; | Promise实例,用于获取异步返回结果。 |
- 示例: - 示例:
...@@ -277,7 +277,7 @@ getLocalDeviceInfoSync(): [DeviceInfo](#deviceinfo) ...@@ -277,7 +277,7 @@ getLocalDeviceInfoSync(): [DeviceInfo](#deviceinfo)
- 返回值: - 返回值:
| 名称 | 说明 | | 名称 | 说明 |
| -------- | -------- | | -------------------------------------- | --------- |
| Array&lt;[DeviceInfo](#deviceinfo)&gt; | 返回本地设备列表。 | | Array&lt;[DeviceInfo](#deviceinfo)&gt; | 返回本地设备列表。 |
- 示例: - 示例:
...@@ -296,7 +296,7 @@ getLocalDeviceInfo(callback:AsyncCallback&lt;DeviceInfo&gt;): void ...@@ -296,7 +296,7 @@ getLocalDeviceInfo(callback:AsyncCallback&lt;DeviceInfo&gt;): void
- 参数: - 参数:
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | --------- |
| callback | AsyncCallback&lt;[DeviceInfo](#deviceinfo)&gt; | 是 | 获取本地设备信息。 | | callback | AsyncCallback&lt;[DeviceInfo](#deviceinfo)&gt; | 是 | 获取本地设备信息。 |
- 示例: - 示例:
...@@ -318,7 +318,7 @@ getLocalDeviceInfo(): Promise&lt;DeviceInfo&gt; ...@@ -318,7 +318,7 @@ getLocalDeviceInfo(): Promise&lt;DeviceInfo&gt;
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ---------------------------------------- | --------------------- |
| Promise&lt;[DeviceInfo](#deviceinfo)&gt; | Promise实例,用于获取异步返回结果。 | | Promise&lt;[DeviceInfo](#deviceinfo)&gt; | Promise实例,用于获取异步返回结果。 |
- 示例: - 示例:
...@@ -340,7 +340,7 @@ startDeviceDiscovery(subscribeInfo: SubscribeInfo): void ...@@ -340,7 +340,7 @@ startDeviceDiscovery(subscribeInfo: SubscribeInfo): void
- 参数: - 参数:
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------------- | ------------------------------- | ---- | ----- |
| subscribeInfo | [SubscribeInfo](#subscribeinfo) | 是 | 发现信息。 | | subscribeInfo | [SubscribeInfo](#subscribeinfo) | 是 | 发现信息。 |
- 示例: - 示例:
...@@ -369,7 +369,7 @@ stopDeviceDiscovery(subscribeId: number): void ...@@ -369,7 +369,7 @@ stopDeviceDiscovery(subscribeId: number): void
- 参数: - 参数:
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ----------- | ------ | ---- | ----- |
| subscribeId | number | 是 | 发现标识。 | | subscribeId | number | 是 | 发现标识。 |
- 示例: - 示例:
...@@ -388,7 +388,7 @@ authenticateDevice(deviceInfo: DeviceInfo, authParam: AuthParam, callback: Async ...@@ -388,7 +388,7 @@ authenticateDevice(deviceInfo: DeviceInfo, authParam: AuthParam, callback: Async
- 参数: - 参数:
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---------- | ---------------------------------------- | ---- | ------- |
| deviceInfo | [DeviceInfo](#deviceinfo) | 是 | 设备信息。 | | deviceInfo | [DeviceInfo](#deviceinfo) | 是 | 设备信息。 |
| authParam | [AuthParam](#authparam) | 是 | 认证参数。 | | authParam | [AuthParam](#authparam) | 是 | 认证参数。 |
| callback | AsyncCallback<{ deviceId: string, pinToken ?: number }> | 是 | 认证结果回调。 | | callback | AsyncCallback<{ deviceId: string, pinToken ?: number }> | 是 | 认证结果回调。 |
...@@ -425,7 +425,7 @@ unAuthenticateDevice(deviceInfo: DeviceInfo): void ...@@ -425,7 +425,7 @@ unAuthenticateDevice(deviceInfo: DeviceInfo): void
- 参数: - 参数:
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---------- | ------------------------- | ---- | ----- |
| deviceInfo | [DeviceInfo](#deviceinfo) | 是 | 设备信息。 | | deviceInfo | [DeviceInfo](#deviceinfo) | 是 | 设备信息。 |
- 示例: - 示例:
...@@ -444,7 +444,7 @@ verifyAuthInfo(authInfo: AuthInfo, callback: AsyncCallback<{deviceId: string, le ...@@ -444,7 +444,7 @@ verifyAuthInfo(authInfo: AuthInfo, callback: AsyncCallback<{deviceId: string, le
- 参数: - 参数:
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ------- |
| authInfo | [AuthInfo](#authinfo) | 是 | 认证信息。 | | authInfo | [AuthInfo](#authinfo) | 是 | 认证信息。 |
| authInfo | AsyncCallback<{ deviceId: string, level: number }> | 是 | 验证结果回调。 | | authInfo | AsyncCallback<{ deviceId: string, level: number }> | 是 | 验证结果回调。 |
...@@ -475,7 +475,7 @@ on(type: 'deviceStateChange', callback: Callback&lt;{ action: DeviceStateChange ...@@ -475,7 +475,7 @@ on(type: 'deviceStateChange', callback: Callback&lt;{ action: DeviceStateChange
- 参数: - 参数:
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ------------------------------ |
| type | string | 是 | 注册设备状态回调,固定为deviceStateChange。 | | type | string | 是 | 注册设备状态回调,固定为deviceStateChange。 |
| callback | Callback&lt;{&nbsp;action:&nbsp;[DeviceStateChangeAction](#devicestatechangeaction),&nbsp;device:&nbsp;[DeviceInfo](#deviceinfo)&nbsp;}&gt; | 是 | 指示要注册的设备状态回调,返回设备状态和设备信息。 | | callback | Callback&lt;{&nbsp;action:&nbsp;[DeviceStateChangeAction](#devicestatechangeaction),&nbsp;device:&nbsp;[DeviceInfo](#deviceinfo)&nbsp;}&gt; | 是 | 指示要注册的设备状态回调,返回设备状态和设备信息。 |
...@@ -498,7 +498,7 @@ off(type: 'deviceStateChange', callback?: Callback&lt;{ action: DeviceStateChang ...@@ -498,7 +498,7 @@ off(type: 'deviceStateChange', callback?: Callback&lt;{ action: DeviceStateChang
- 参数: - 参数:
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | --------------------------- |
| type | string | 是 | 根据应用程序的包名取消注册设备状态回调。 | | type | string | 是 | 根据应用程序的包名取消注册设备状态回调。 |
| callback | Callback&lt;{&nbsp;action:&nbsp;[DeviceStateChangeAction](#devicestatechangeaction),&nbsp;device:&nbsp;[DeviceInfo](#deviceinfo)&nbsp;&nbsp;}&gt; | 是 | 指示要取消注册的设备状态回调,返回设备状态和设备信息。 | | callback | Callback&lt;{&nbsp;action:&nbsp;[DeviceStateChangeAction](#devicestatechangeaction),&nbsp;device:&nbsp;[DeviceInfo](#deviceinfo)&nbsp;&nbsp;}&gt; | 是 | 指示要取消注册的设备状态回调,返回设备状态和设备信息。 |
...@@ -521,7 +521,7 @@ on(type: 'deviceFound', callback: Callback&lt;{ subscribeId: number, device: Dev ...@@ -521,7 +521,7 @@ on(type: 'deviceFound', callback: Callback&lt;{ subscribeId: number, device: Dev
- 参数: - 参数:
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | -------------------------- |
| type | string | 是 | 注册设备发现回调,以便在发现周边设备时通知应用程序。 | | type | string | 是 | 注册设备发现回调,以便在发现周边设备时通知应用程序。 |
| callback | Callback&lt;{&nbsp;subscribeId: number, device: DeviceInfo&nbsp;}&gt; | 是 | 注册设备发现的回调方法。 | | callback | Callback&lt;{&nbsp;subscribeId: number, device: DeviceInfo&nbsp;}&gt; | 是 | 注册设备发现的回调方法。 |
...@@ -543,7 +543,7 @@ off(type: 'deviceFound', callback?: Callback&lt;{ subscribeId: number, device: D ...@@ -543,7 +543,7 @@ off(type: 'deviceFound', callback?: Callback&lt;{ subscribeId: number, device: D
- 参数: - 参数:
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | --------------------------- |
| type | string | 是 | 取消注册设备发现回调。 | | type | string | 是 | 取消注册设备发现回调。 |
| callback | Callback&lt;{&nbsp;subscribeId: number, device: [DeviceInfo](#deviceinfo)&nbsp;}&gt; | 是 | 指示要取消注册的设备发现回调,返回设备状态和设备信息。 | | callback | Callback&lt;{&nbsp;subscribeId: number, device: [DeviceInfo](#deviceinfo)&nbsp;}&gt; | 是 | 指示要取消注册的设备发现回调,返回设备状态和设备信息。 |
...@@ -565,7 +565,7 @@ on(type: 'discoverFail', callback: Callback&lt;{ subscribeId: number, reason: nu ...@@ -565,7 +565,7 @@ on(type: 'discoverFail', callback: Callback&lt;{ subscribeId: number, reason: nu
- 参数: - 参数:
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ------------------------------ |
| type | string | 是 | 注册设备发现失败回调,以便在发现周边设备失败时通知应用程序。 | | type | string | 是 | 注册设备发现失败回调,以便在发现周边设备失败时通知应用程序。 |
| callback | Callback&lt;{&nbsp;subscribeId: number, reason: number&nbsp;}&gt; | 是 | 注册设备发现失败的回调方法。 | | callback | Callback&lt;{&nbsp;subscribeId: number, reason: number&nbsp;}&gt; | 是 | 注册设备发现失败的回调方法。 |
...@@ -587,7 +587,7 @@ off(type: 'discoverFail', callback?: Callback&lt;{ subscribeId: number, reason: ...@@ -587,7 +587,7 @@ off(type: 'discoverFail', callback?: Callback&lt;{ subscribeId: number, reason:
- 参数: - 参数:
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ----------------- |
| type | string | 是 | 取消注册设备发现失败回调。 | | type | string | 是 | 取消注册设备发现失败回调。 |
| callback | Callback&lt;{&nbsp;subscribeId: number, reason: number&nbsp;}&gt; | 是 | 指示要取消注册的设备发现失败回调。 | | callback | Callback&lt;{&nbsp;subscribeId: number, reason: number&nbsp;}&gt; | 是 | 指示要取消注册的设备发现失败回调。 |
...@@ -610,7 +610,7 @@ on(type: 'serviceDie', callback: () =&gt; void): void ...@@ -610,7 +610,7 @@ on(type: 'serviceDie', callback: () =&gt; void): void
- 参数: - 参数:
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ----------------------- | ---- | ---------------------------------------- |
| type | string | 是 | 注册serviceDie回调,以便在devicemanager服务异常终止时通知应用程序。 | | type | string | 是 | 注册serviceDie回调,以便在devicemanager服务异常终止时通知应用程序。 |
| callback | ()&nbsp;=&gt;&nbsp;void | 是 | 注册serviceDie的回调方法。 | | callback | ()&nbsp;=&gt;&nbsp;void | 是 | 注册serviceDie的回调方法。 |
...@@ -633,7 +633,7 @@ off(type: 'serviceDie', callback?: () =&gt; void): void ...@@ -633,7 +633,7 @@ off(type: 'serviceDie', callback?: () =&gt; void): void
- 参数: - 参数:
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ----------------------- | ---- | ---------------------------------------- |
| type | string | 是 | 取消注册serviceDie回调,以便在devicemanager服务异常终止时通知应用程序。 | | type | string | 是 | 取消注册serviceDie回调,以便在devicemanager服务异常终止时通知应用程序。 |
| callback | ()&nbsp;=&gt;&nbsp;void | 否 | 取消注册serviceDie的回调方法。 | | callback | ()&nbsp;=&gt;&nbsp;void | 否 | 取消注册serviceDie的回调方法。 |
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册