Skip to content

D
Docs

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

通知 161
Star 293
Fork 28
D
Docs
“1d7954fc3f81ab5e5c151c57d37d5a936bf00f0e”上不存在“...math/git@gitcode.net:s920243400/PaddleDetection.git”
未验证 提交 412681d8 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!20084 【分布式硬件DM】添加北向接口 

Merge pull request !20084 from 史晓晓/master
上级 93c1e492 5734071b
隐藏空白更改
内联 并排
Showing with 1052 addition and 0 deletion
zh-cn/application-dev/reference/apis/js-apis-distributedDeviceManager.md 0 → 100644
浏览文件 @ 412681d8
# @ohos.distributedDeviceManager (设备管理)
本模块提供分布式设备管理能力。
应用可调用接口实现如下功能：
- 注册和解除注册设备上下线变化监听
- 发现周边不可信设备
- 认证和取消认证设备
- 查询可信设备列表
- 查询本地设备信息，包括设备名称，设备类型和设备标识等。
> **说明：**
>
> - 本模块首批接口从API version 10开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
```js
import deviceManager from '@ohos.distributedDeviceManager';
```
## deviceManager.createDeviceManager
createDeviceManager(bundleName: string): DeviceManager;
创建一个设备管理实例。设备管理实例是分布式设备管理方法的调用入口。用于获取可信设备和本地设备的相关信息。
**系统能力**：以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ---------------------------------------------------- | ---- | ----------------------------------------------------------- |
| bundleName | string | 是 | 指示应用程序的Bundle名称。 |
**返回值：**
| 名称 | 说明 |
| ------------------------------------------- | --------- |
| [DeviceManager](#devicemanager) | 返回设备管理器对象实例。 |
**示例：**
```js
try {
let dmInstance = deviceManager.createDeviceManager("ohos.samples.jshelloworld");
} catch(err) {
console.error("createDeviceManager errCode:" + err.code + ",errMessage:" + err.message);
}
```
## deviceManager.releaseDeviceManager
releaseDeviceManager(deviceManager: DeviceManager): void;
设备管理实例不再使用后，通过该方法释放DeviceManager实例。
**需要权限**：ohos.permission.DISTRIBUTED_DATASYNC
**系统能力**：SystemCapability.DistributedHardware.DeviceManager
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ---------------------------------------------------- | ---- | --------------------------------- |
| deviceManager | [DeviceManager](#devicemanager) | 是 | 设备管理器对象实例。 |
**错误码：**
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function. |
**示例：**
```js
try {
deviceManager.releaseDeviceManager(dmInstance);
} catch (err) {
console.error("release device manager errCode:" + err.code + ",errMessage:" + err.message);
}
```
## DeviceBasicInfo
分布式设备基本信息。
**系统能力**：以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager
| 名称 | 类型 | 必填 | 说明 |
| ---------------------- | ------------------------- | ---- | -------- |
| deviceId | string | 是 | 设备的唯一标识。 实际值是udid-hash与基于sha256的appid混淆。|
| deviceName | string | 是 | 设备名称。 |
| deviceType | number | 是 | 设备类型。 |
| networkId | string | 否 | 设备网络标识。 |
## DeviceStateChange
表示设备状态。
**系统能力**：以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager
| 名称 | 值 | 说明 |
| ----------- | ---- | --------------- |
| UNKNOWN | 0 | 设备物理上线，此时状态未知，在状态更改为可用之前，分布式业务无法使用。 |
| AVAILABLE | 1 | 设备可用状态，表示设备间信息已在分布式数据中同步完成, 可以运行分布式业务。 |
| UNAVAILABLE | 2 | 设备物理下线，此时状态未知。 |
## DeviceManager
设备管理实例，用于获取可信设备和本地设备的相关信息。在调用DeviceManager的方法前，需要先通过createDeviceManager构建一个DeviceManager实例dmInstance。
### getAvailableDeviceListSync
getAvailableDeviceListSync(): Array<DeviceBasicInfo>;
同步获取所有可信设备列表。
**需要权限**：ohos.permission.DISTRIBUTED_DATASYNC
**系统能力**：SystemCapability.DistributedHardware.DeviceManager
**返回值：**
| 名称 | 说明 |
| ------------------------------------------- | --------- |
| Array<[DeviceBasicInfo](#devicebasicinfo)> | 返回可信设备列表。 |
**错误码：**
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function. |
**示例：**
```js
try {
var deviceInfoList = dmInstance.getAvailableDeviceListSync();
} catch (err) {
console.error("getAvailableDeviceListSync errCode:" + err.code + ",errMessage:" + err.message);
}
```
### getAvailableDeviceList
getAvailableDeviceList(callback:AsyncCallback<Array<DeviceBasicInfo>>): void;
获取所有可信设备列表。使用callback异步回调。
**需要权限**：ohos.permission.DISTRIBUTED_DATASYNC
**系统能力**：SystemCapability.DistributedHardware.DeviceManager
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------------------- |
| callback | AsyncCallback<Array<[DeviceBasicInfo](#devicebasicinfo)>> | 是 | 获取所有可信设备列表的回调，返回设备信息。 |
**错误码：**
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function. |
**示例：**
```js
try {
dmInstance.getAvailableDeviceList((err, data) => {
if (err) {
console.error("getAvailableDeviceList errCode:" + err.code + ",errMessage:" + err.message);
return;
}
console.log('get available device info: ' + JSON.stringify(data));
});
} catch (err) {
console.error("getAvailableDeviceList errCode:" + err.code + ",errMessage:" + err.message);
}
```
### getAvailableDeviceList
getAvailableDeviceList(): Promise<Array<DeviceBasicInfo>>;
获取所有可信设备列表。使用Promise异步回调。
**需要权限**：ohos.permission.DISTRIBUTED_DATASYNC
**系统能力**：SystemCapability.DistributedHardware.DeviceManager
**返回值：**
| 类型 | 说明 |
| ---------------------------------------------------------- | ---------------------------------- |
| Promise<Array<[DeviceBasicInfo](#devicebasicinfo)>> | Promise实例，用于获取异步返回结果。 |
**错误码：**
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function. |
**示例：**
```js
dmInstance.getAvailableDeviceList().then((data) => {
console.log('get available device info: ' + JSON.stringify(data));
}).catch((err) => {
console.error("getAvailableDeviceList errCode:" + err.code + ",errMessage:" + err.message);
});
```
### getLocalDeviceNetworkId
getLocalDeviceNetworkId(): string;
获取本地设备网络标识。
**需要权限**：ohos.permission.DISTRIBUTED_DATASYNC
**系统能力**：SystemCapability.DistributedHardware.DeviceManager
**返回值：**
| 名称 | 说明 |
| ------------------------- | ---------------- |
| string | 返回本地设备网络标识。 |
**错误码：**
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function. |
**示例：**
```js
try {
var deviceNetworkId = dmInstance.getLocalDeviceNetworkId();
console.log('local device networkId: ' + JSON.stringify(deviceNetworkId));
} catch (err) {
console.error("getLocalDeviceNetworkId errCode:" + err.code + ",errMessage:" + err.message);
}
```
### getLocalDeviceName
getLocalDeviceName(): string;
获取本地设备名称。
**需要权限**：ohos.permission.DISTRIBUTED_DATASYNC
**系统能力**：SystemCapability.DistributedHardware.DeviceManager
**返回值：**
| 名称 | 说明 |
| ------------------------- | ---------------- |
| string | 返回本地设备名称。 |
**错误码：**
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function. |
**示例：**
```js
try {
var deviceName = dmInstance.getLocalDeviceName();
console.log('local device name: ' + JSON.stringify(deviceName));
} catch (err) {
console.error("getLocalDeviceName errCode:" + err.code + ",errMessage:" + err.message);
}
```
### getLocalDeviceType
getLocalDeviceType(): number;
获取本地设备类型。
**需要权限**：ohos.permission.DISTRIBUTED_DATASYNC
**系统能力**：SystemCapability.DistributedHardware.DeviceManager
**返回值：**
| 名称 | 说明 |
| ------------------------- | ---------------- |
| number | 返回本地设备类型。 |
**错误码：**
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function. |
**示例：**
```js
try {
var deviceType = dmInstance.getLocalDeviceType();
console.log('local device type: ' + JSON.stringify(deviceType));
} catch (err) {
console.error("getLocalDeviceType errCode:" + err.code + ",errMessage:" + err.message);
}
```
### getLocalDeviceId
getLocalDeviceId(): string;
获取本地设备id。
**需要权限**：ohos.permission.DISTRIBUTED_DATASYNC
**系统能力**：SystemCapability.DistributedHardware.DeviceManager
**返回值：**
| 名称 | 说明 |
| ------------------------- | ---------------- |
| string | 返回本地设备id。 |
**错误码：**
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function. |
**示例：**
```js
try {
var deviceId = dmInstance.getLocalDeviceId();
console.log('local device id: ' + JSON.stringify(deviceId));
} catch (err) {
console.error("getLocalDeviceId errCode:" + err.code + ",errMessage:" + err.message);
}
```
### getDeviceName
getDeviceName(networkId: string): string;
通过指定设备的网络标识获取该设备名称。
**需要权限**：ohos.permission.DISTRIBUTED_DATASYNC
**系统能力**：SystemCapability.DistributedHardware.DeviceManager
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------- |
| networkId| string | 是 | 设备的网络标识。 |
**返回值：**
| 名称 | 说明 |
| ------------------------- | ---------------- |
| string | 返回指定设备名称。 |
**错误码：**
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function. |
**示例：**
```js
try {
// 设备网络标识，可以从可信设备列表中获取
let networkId = "xxxxxxx"
var deviceName = dmInstance.getDeviceName(networkId);
console.log('device name: ' + JSON.stringify(deviceName));
} catch (err) {
console.error("getDeviceName errCode:" + err.code + ",errMessage:" + err.message);
}
```
### getDeviceType
getDeviceType(networkId: string): number;
通过指定设备的网络标识获取该设备类型。
**需要权限**：ohos.permission.DISTRIBUTED_DATASYNC
**系统能力**：SystemCapability.DistributedHardware.DeviceManager
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------- |
| networkId| string | 是 | 设备的网络标识。 |
**返回值：**
| 名称 | 说明 |
| ------------------------- | ---------------- |
| number | 返回指定设备类型。 |
**错误码：**
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function. |
**示例：**
```js
try {
// 设备网络标识，可以从可信设备列表中获取
let networkId = "xxxxxxx"
var deviceType = dmInstance.getDeviceType(networkId);
console.log('device type: ' + JSON.stringify(deviceType));
} catch (err) {
console.error("getDeviceType errCode:" + err.code + ",errMessage:" + err.message);
}
```
### startDiscovering
startDiscovering(discoverParam: {[key: string]: Object} , filterOptions?: {[key: string]: Object} ): void;
发现周边设备。发现状态持续两分钟，超过两分钟，会停止发现，最大发现数量99个。
**需要权限**：ohos.permission.DISTRIBUTED_DATASYNC
**系统能力**：SystemCapability.DistributedHardware.DeviceManager
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------------- | ------------------------------- | ---- | ----- |
| discoverParam | {[key:&nbsp;string]:&nbsp;Object} | 是 | 发现标识。 标识发现的目标类型。<br>discoverTargetType: 发现目标默认为设备，值为1。|
| filterOptions | {[key:&nbsp;string]:&nbsp;Object} | 否 | 发现设备过滤信息。可选，默认为undefined，发现未上线设备。会携带以下key值：<br>availableStatus(0-1): 仅发现设备可信，值为0表示设备不可信。<br />-0: 设备离线，客户端需要通过调用bindTarget绑定设备。<br />-1: 设备已在线，客户可以进行连接。<br>discoverDistance(0-100): 发现距离本地一定距离内的设备，单位为cm。 <br>authenticationStatus(0-1): 根据不同的认证状态发现设备：<br />-0: 设备未认证。<br />-1：设备已认证。<br>authorizationType(0-2)：根据不同的授权类型发现设备：<br />-0: 根据临时协商的会话密钥认证的设备。<br />-1: 基于同账号密钥进行身份验证的设备。<br />-2: 基于不同账号凭据密钥认证的设备。|
**错误码：**
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function. |
| 11600104 | Discovery repeats. |
**示例：**
```js
var discoverParam = {
'discoverTargetType': 1
};
var filterOptions = {
'availableStatus': 1,
'discoverDistance': 50,
'authenticationStatus': 0,
'authorizationType': 0
};
try {
dmInstance.startDiscovering(discoverParam, filterOptions); // 当有设备发现时，通过discoverSuccess回调通知给应用程序
} catch (err) {
console.error("startDiscovering errCode:" + err.code + ",errMessage:" + err.message);
}
```
### stopDiscovering
stopDiscovering(): void;
停止发现周边设备。
**需要权限**：ohos.permission.DISTRIBUTED_DATASYNC
**系统能力**：SystemCapability.DistributedHardware.DeviceManager
**错误码：**
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function. |
| 11600104 | Stop discovery repeats. |
**示例：**
```js
try {
dmInstance.stopDiscovering();
} catch (err) {
console.error("stopDiscovering errCode:" + err.code + ",errMessage:" + err.message);
}
```
### bindTarget
bindTarget(deviceId: string, bindParam: {[key:&nbsp;string]:&nbsp;Object} , callback: AsyncCallback&lt;{deviceId: string}>): void;
认证设备。
**需要权限**：ohos.permission.DISTRIBUTED_DATASYNC
**系统能力**：SystemCapability.DistributedHardware.DeviceManager
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | --------------------------------------------------- | ----- | ------------ |
| deviceId | string | 是 | 设备标识。 |
| bindParam | {[key:&nbsp;string]:&nbsp;Object} | 是 | 认证参数。由开发者自行决定传入的键值对。默认会携带以下key值: <br>bindType 此值是绑定的类型。<br />-1 PIN码。<br />-2 二维码。<br />-3 NFC。 <br />-4 无交互。<br>targetPkgName 绑定目标的包名。<br>appName 尝试绑定目标的应用程序名称。<br>appOperation 应用程序要绑定目标的原因。<br>customDescription 操作的详细说明。 |
| callback | AsyncCallback&lt;{deviceId:&nbsp;string,&nbsp;}&gt; | 是 | 认证结果回调 |
**错误码：**
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function. |
| 11600103 | Bind invalid. |
**示例：**
```js
// 认证的设备信息，可以从发现的结果中获取
var deviceId ="XXXXXXXX";
let bindParam = {
'bindType': 1,// 认证类型： 1 - 无帐号PIN码认证
'targetPkgName': 'xxxx',
'appName': 'xxxx',
'appOperation': 'xxxx',
'customDescription': 'xxxx'
}
try {
dmInstance.bindTarget(deviceId, bindParam, (err, data) => {
if (err) {
console.error("bindTarget errCode:" + err.code + ",errMessage:" + err.message);
return;
}
console.info("bindTarget result:" + JSON.stringify(data));
});
} catch (err) {
console.error("bindTarget errCode:" + err.code + ",errMessage:" + err.message);
}
```
### unbindTarget
unbindTarget(deviceId: string): void;
解除认证设备。
**需要权限**：ohos.permission.DISTRIBUTED_DATASYNC
**系统能力**：SystemCapability.DistributedHardware.DeviceManager
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- |
| deviceId | string | 是 | 设备标识。 |
**错误码：**
以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function. |
**示例：**
```js
try {
var deviceId ="XXXXXXXX";
dmInstance.unbindTarget(deviceId);
} catch (err) {
console.error("unbindTarget errCode:" + err.code + ",errMessage:" + err.message);
}
```
### replyUiAction
replyUiAction(action: number, actionResult: string): void;
回复用户ui操作行为。此接口只能被devicemanager的PIN码hap使用。
**需要权限**：ohos.permission.ACCESS_SERVICE_DM
**系统能力**：SystemCapability.DistributedHardware.DeviceManager
**系统API**： 此接口为系统接口。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------------- | --------------- | ---- | ------------------- |
| action | number | 是 | 用户操作动作。 |
| actionResult | string | 是 | 表示用户操作结果。 |
**示例：**
```js
try {
/*
action = 0 - 允许授权
action = 1 - 取消授权
action = 2 - 授权框用户操作超时
action = 3 - 取消pin码框展示
action = 4 - 取消pin码输入框展示
action = 5 - pin码输入框确定操作
*/
let operation = 0;
dmInstance.replyUiAction(operation, "extra")
} catch (err) {
console.error("replyUiAction errCode:" + err.code + ",errMessage:" + err.message);
}
```
### on('replyResult')
on(type: 'replyResult', callback: Callback&lt;{ param: string}&gt;): void;
回复UI操作结果回调。
**需要权限**：ohos.permission.ACCESS_SERVICE_DM
**系统能力**：SystemCapability.DistributedHardware.DeviceManager
**系统API**： 此接口为系统接口。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------ | ---- | ------------------------------ |
| type | string | 是 | 注册的设备管理器 ui 状态回调，以便在状态改变时通知应用。 |
| callback | Callback&lt;{&nbsp;param:&nbsp;string}&gt; | 是 | 指示要注册的设备管理器 ui 状态回调，返回ui状态。 |
**示例：**
```js
try {
dmInstance.on('replyResult', (data) => {
console.log("replyResult executed, dialog closed" + JSON.stringify(data))
var tmpStr = JSON.parse(data.param)
var isShow = tmpStr.verifyFailed
console.log("replyResult executed, dialog closed" + isShow)
});
} catch (err) {
console.error("replyResult errCode:" + err.code + ",errMessage:" + err.message);
}
```
### off('replyResult')
off(type: 'replyResult', callback?: Callback&lt;{ param: string}&gt;): void;
取消回复UI操作结果回调。
**需要权限**：ohos.permission.ACCESS_SERVICE_DM
**系统能力**：SystemCapability.DistributedHardware.DeviceManager
**系统API**： 此接口为系统接口。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------- | ---- | ------------------------------ |
| type | string | 是 | 取消注册的设备管理器 ui 状态回调。 |
| callback | Callback&lt;{&nbsp;param:&nbsp;string}&gt; | 否 | 指示要取消注册的设备管理器 ui 状态，返回UI状态。 |
**示例：**
```js
try {
dmInstance.off('replyResult');
} catch (err) {
console.error("replyResult errCode:" + err.code + ",errMessage:" + err.message);
}
```
### on('deviceStateChange')
on(type: 'deviceStateChange', callback: Callback&lt;{ action: DeviceStateChange, device: DeviceBasicInfo }&gt;): void;
注册设备状态回调。
**需要权限**：ohos.permission.DISTRIBUTED_DATASYNC
**系统能力**：SystemCapability.DistributedHardware.DeviceManager
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------------ |
| type | string | 是 | 注册设备状态回调，固定为deviceStateChange。 |
| callback | Callback&lt;{&nbsp;action:&nbsp;[DeviceStateChange](#devicestatechange),&nbsp;device:&nbsp;[DeviceBasicInfo](#devicebasicinfo)&nbsp;}&gt; | 是 | 指示要注册的设备状态回调，返回设备状态和设备信息。 |
**示例：**
```js
try {
dmInstance.on('deviceStateChange', (data) => {
console.info("deviceStateChange on:" + JSON.stringify(data));
});
} catch (err) {
console.error("deviceStateChange errCode:" + err.code + ",errMessage:" + err.message);
}
```
### off('deviceStateChange')
off(type: 'deviceStateChange', callback?: Callback&lt;{ action: DeviceStateChange, device: DeviceBasicInfo }&gt;): void;
取消注册设备状态回调。
**需要权限**：ohos.permission.DISTRIBUTED_DATASYNC
**系统能力**：SystemCapability.DistributedHardware.DeviceManager
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------------------------- |
| type | string | 是 | 根据应用程序的包名取消注册设备状态回调。 |
| callback | Callback&lt;{&nbsp;action:&nbsp;[deviceStateChange](#devicestatechange),&nbsp;device:&nbsp;[DeviceBasicInfo](#devicebasicinfo)&nbsp;}&gt; | 否 | 指示要取消注册的设备状态回调，返回设备状态和设备信息。 |
**示例：**
```js
try {
dmInstance.off('deviceStatusChange', (data) => {
console.info('deviceStatusChange' + JSON.stringify(data));
});
} catch (err) {
console.error("deviceStatusChange errCode:" + err.code + ",errMessage:" + err.message);
}
```
### on('discoverSuccess')
on(type: 'discoverSuccess', callback: Callback&lt;{ device: DeviceBasicInfo }&gt;): void;
注册发现设备成功回调监听。
**需要权限**：ohos.permission.DISTRIBUTED_DATASYNC
**系统能力**：SystemCapability.DistributedHardware.DeviceManager
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | -------------------------- |
| type | string | 是 | 注册设备发现回调，以便在发现周边设备时通知应用程序。 |
| callback | Callback&lt;{&nbsp;device:&nbsp;[DeviceBasicInfo](#devicebasicinfo)&nbsp;}&gt; | 是 | 注册设备发现的回调方法。 |
**示例：**
```js
try {
dmInstance.on('discoverSuccess', (data) => {
console.info("discoverSuccess:" + JSON.stringify(data));
});
} catch (err) {
console.error("discoverSuccess errCode:" + err.code + ",errMessage:" + err.message);
}
```
### off('discoverSuccess')
off(type: 'discoverSuccess', callback?: Callback&lt;{ device: DeviceBasicInfo }&gt;): void;
取消注册设备发现成功回调。
**需要权限**：ohos.permission.DISTRIBUTED_DATASYNC
**系统能力**：SystemCapability.DistributedHardware.DeviceManager
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------------------------- |
| type | string | 是 | 取消注册设备发现回调。 |
| callback | Callback&lt;{&nbsp;device:&nbsp;[DeviceBasicInfo](#devicebasicinfo)&nbsp;}&gt; | 否 | 指示要取消注册的设备发现回调，返回设备状态和设备信息。 |
**示例：**
```js
try {
dmInstance.off('discoverSuccess', (data) => {
console.info('discoverSuccess' + JSON.stringify(data));
});
} catch (err) {
console.error("discoverSuccess errCode:" + err.code + ",errMessage:" + err.message);
}
```
### on('deviceNameChange')
on(type: 'deviceNameChange', callback: Callback&lt;{ deviceName: string }&gt;): void;
注册设备名称变更回调监听。
**需要权限**：ohos.permission.DISTRIBUTED_DATASYNC
**系统能力**：SystemCapability.DistributedHardware.DeviceManager
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------------ |
| type | string | 是 | 注册设备名称改变回调，以便在设备名称改变时通知应用程序。 |
| callback | Callback&lt;{&nbsp;deviceName:&nbsp;string}&gt; | 是 | 注册设备名称改变的回调方法。 |
**示例：**
```js
try {
dmInstance.on('deviceNameChange', (data) => {
console.info("deviceNameChange on:" + JSON.stringify(data));
});
} catch (err) {
console.error("deviceNameChange errCode:" + err.code + ",errMessage:" + err.message);
}
```
### off('deviceNameChange')
off(type: 'deviceNameChange', callback?: Callback&lt;{ deviceName: string }&gt;): void;
取消注册设备名称变更回调监听。
**需要权限**：ohos.permission.DISTRIBUTED_DATASYNC
**系统能力**：SystemCapability.DistributedHardware.DeviceManager
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------------ |
| type | string | 是 | 取消注册设备名称改变回调。 |
| callback | Callback&lt;{&nbsp;deviceName:&nbsp;string}&gt; | 否 | 指示要取消注册设备名称改变的回调方法。 |
**示例：**
```js
try {
dmInstance.off('deviceNameChange', (data) => {
console.info('deviceNameChange' + JSON.stringify(data));
});
} catch (err) {
console.error("deviceNameChange errCode:" + err.code + ",errMessage:" + err.message);
}
```
### on('discoverFailure')
on(type: 'discoverFailure', callback: Callback&lt;{ reason: number }&gt;): void;
注册设备发现失败回调监听。
**需要权限**：ohos.permission.DISTRIBUTED_DATASYNC
**系统能力**：SystemCapability.DistributedHardware.DeviceManager
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------------ |
| type | string | 是 | 注册设备发现失败回调，以便在发现周边设备失败时通知应用程序。 |
| callback | Callback&lt;{&nbsp;reason:&nbsp;number&nbsp;}&gt; | 是 | 注册设备发现失败的回调方法。 |
**示例：**
```js
try {
dmInstance.on('discoverFailure', (data) => {
console.info("discoverFailure on:" + JSON.stringify(data));
});
} catch (err) {
console.error("discoverFailure errCode:" + err.code + ",errMessage:" + err.message);
}
```
### off('discoverFailure')
off(type: 'discoverFailure', callback?: Callback&lt;{ reason: number }&gt;): void;
取消注册设备发现失败回调。
**需要权限**：ohos.permission.DISTRIBUTED_DATASYNC
**系统能力**：SystemCapability.DistributedHardware.DeviceManager
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ----------------- |
| type | string | 是 | 取消注册设备发现失败回调。 |
| callback | Callback&lt;{&nbsp;reason:&nbsp;number&nbsp;}&gt; | 否 | 指示要取消注册的设备发现失败回调。 |
**示例：**
```js
try {
dmInstance.off('discoverFailure', (data) => {
console.info('discoverFailure' + JSON.stringify(data));
});
} catch (err) {
console.error("discoverFailure errCode:" + err.code + ",errMessage:" + err.message);
}
```
### on('serviceDie')
on(type: 'serviceDie', callback?: Callback&lt;{}&gt;): void;
注册设备管理服务死亡监听。
**需要权限**：ohos.permission.DISTRIBUTED_DATASYNC
**系统能力**：SystemCapability.DistributedHardware.DeviceManager
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | ---------------------------------------- |
| type | string | 是 | 注册serviceDie回调，以便在devicemanager服务异常终止时通知应用程序。 |
| callback | Callback&lt;{}&gt; | 否 | 注册serviceDie的回调方法。 |
**示例：**
```js
try {
dmInstance.on("serviceDie", () => {
console.info("serviceDie on");
});
} catch (err) {
console.error("serviceDie errCode:" + err.code + ",errMessage:" + err.message);
}
```
### off('serviceDie')
off(type: 'serviceDie', callback?: Callback&lt;{}&gt;): void;
取消注册设备管理服务死亡监听。
**需要权限**：ohos.permission.DISTRIBUTED_DATASYNC
**系统能力**：SystemCapability.DistributedHardware.DeviceManager
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | ---------------------------------------- |
| type | string | 是 | 取消注册serviceDie回调，以便在devicemanager服务异常终止时通知应用程序。 |
| callback | Callback&lt;{}&gt; | 否 | 取消注册serviceDie的回调方法。 |
**示例：**
```js
try {
dmInstance.off("serviceDie", () => {
console.info("serviceDie off");
});
} catch (err) {
console.error("serviceDie errCode:" + err.code + ",errMessage:" + err.message);
}
```
\ No newline at end of file
zh-cn/release-notes/changelogs/OpenHarmony_4.0.9.2/changelogs-distributedDeviceManager.md 0 → 100644
浏览文件 @ 412681d8
# 设备管理ChangeLog
## cl.distributedDeviceManager.1 接口变更
从Openharmony 4.0.9.2版本开始，新增设备管理接口。
**变更影响**
原有的接口[API参考](../../../application-dev/reference/apis/js-apis-device-manager.md)暂时可继续使用，但是停止维护，建议使用新接口进行开发。
**关键的接口/组件变更**
##新增接口如下:
| 模块名 | 类名 | 新增接口声明 |
| ------------------------------------ | ------------------- | ------------------------------------------------------------ |
| @ohos.distributedDeviceManager | function | **function** createDeviceManager(bundleName: string): DeviceManager; |
| @ohos.distributedDeviceManager | function | **function** releaseDeviceManager(deviceManager: DeviceManager): void; |
| @ohos.distributedDeviceManager | DeviceManager | **function** getAvailableDeviceListSync(): Array&lt;DeviceBasicInfo&gt;; |
| @ohos.distributedDeviceManager | DeviceManager | **function** getAvailableDeviceList(callback:AsyncCallback&lt;Array&lt;DeviceBasicInfo&gt;&gt;): void; |
| @ohos.distributedDeviceManager | DeviceManager | **function** getAvailableDeviceList(): Promise&lt;Array&lt;DeviceBasicInfo&gt;&gt;; |
| @ohos.distributedDeviceManager | DeviceManager | **function** getLocalDeviceNetworkId(): string; |
| @ohos.distributedDeviceManager | DeviceManager | **function** getLocalDeviceName(): string; |
| @ohos.distributedDeviceManager | DeviceManager | **function** getLocalDeviceType(): number; |
| @ohos.distributedDeviceManager | DeviceManager | **function** getLocalDeviceId(): string; |
| @ohos.distributedDeviceManager | DeviceManager | **function** getDeviceName(networkId: string): string; |
| @ohos.distributedDeviceManager | DeviceManager | **function** getDeviceType(networkId: string): number; |
| @ohos.distributedDeviceManager | DeviceManager | **function** startDiscovering(discoverParam: {[key:&nbsp;string]:&nbsp;Object} , filterOptions?: {[key:&nbsp;string]:&nbsp;Object} ): void; |
| @ohos.distributedDeviceManager | DeviceManager | **function** stopDiscovering(): void; |
| @ohos.distributedDeviceManager | DeviceManager | **function** bindTarget(deviceId: string, bindParam: {[key:&nbsp;string]:&nbsp;Object} , callback: AsyncCallback&lt;{deviceId: string}&gt;): void; |
| @ohos.distributedDeviceManager | DeviceManager | **function** unbindTarget(deviceId: string): void; |
| @ohos.distributedDeviceManager | DeviceManager | **function** replyUiAction(action: number, actionResult: string): void; |
| @ohos.distributedDeviceManager | DeviceManager | **function** on(type: 'replyResult', callback: Callback&lt;{ param: string}&gt;): void; |
| @ohos.distributedDeviceManager | DeviceManager | **function** off(type: 'replyResult', callback?: Callback&lt;{ param: string}&gt;): void; |
| @ohos.distributedDeviceManager | DeviceManager | **function** on(type: 'deviceStateChange', callback: Callback&lt;{ action: DeviceStateChange, device: DeviceBasicInfo }&gt;): void; |
| @ohos.distributedDeviceManager | DeviceManager | **function** off(type: 'deviceStateChange', callback?: Callback&lt;{ action: DeviceStateChange, device: DeviceBasicInfo }&gt;): void; |
| @ohos.distributedDeviceManager | DeviceManager | **function** on(type: 'discoverSuccess', callback: Callback&lt;{ device: DeviceBasicInfo }&gt;): void; |
| @ohos.distributedDeviceManager | DeviceManager | **function** off(type: 'discoverSuccess', callback?: Callback&lt;{ device: DeviceBasicInfo }&gt;): void; |
| @ohos.distributedDeviceManager | DeviceManager | **function** on(type: 'deviceNameChange', callback: Callback&lt;{ deviceName: string }&gt;): void; |
| @ohos.distributedDeviceManager | DeviceManager | **function** off(type: 'deviceNameChange', callback?: Callback&lt;{ deviceName: string }&gt;): void; |
| @ohos.distributedDeviceManager | DeviceManager | **function** on(type: 'discoverFailure', callback: Callback&lt;{ reason: number }&gt;): void; |
| @ohos.distributedDeviceManager | DeviceManager | **function** off(type: 'discoverFailure', callback?: Callback&lt;{ reason: number }&gt;): void; |
| @ohos.distributedDeviceManager | DeviceManager | **function** on(type: 'serviceDie', callback?: Callback&lt;{}&gt;): void; |
| @ohos.distributedDeviceManager | DeviceManager | **function** off(type: 'serviceDie', callback?: Callback&lt;{}&gt;): void; |
**适配指导**
请参考各接口的[API参考](../../../application-dev/reference/apis/js-apis-distributedDeviceManager.md)
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或