@ohos.distributedDeviceManager (设备管理)(系统接口)

本模块提供分布式设备管理能力。

应用可调用接口实现如下功能：

• 注册和解除注册设备上下线变化监听。
• 发现周边不可信设备。
• 认证和取消认证设备。
• 查询可信设备列表。
• 查询本地设备信息，包括设备名称，设备类型和设备标识等。

说明：

本模块首批接口从API version 10开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。当前页面仅包含本模块的系统接口，其他公开接口参见@ohos.distributedDeviceManager (设备管理)。

导入模块

import { distributedDeviceManager } from '@kit.DistributedServiceKit';

StrategyForHeartbeat¹⁵⁺

表示心跳广播策略。

系统能力：SystemCapability.DistributedHardware.DeviceManager

系统API： 此接口为系统接口。

DeviceProfileInfoFilterOptions¹⁵⁺

设备信息过滤器选项。

系统能力：SystemCapability.DistributedHardware.DeviceManager

系统API： 此接口为系统接口。

|名称 |类型|只读|可选 | 说明 | |———–|—-|–|—|—————| |isCloud |boolean | 否|否 |表示是否需要实时从云端获取设备列表。
- false：表示从设备获取。
- true：表示从云端获取。 | |deviceIdList|Array<string>|否|是 |表示获取指定deviceId的设备信息，deviceId一般为设备的UDID，如设备无UDID，则取其MAC或SN作为deviceId。默认为空。 |

ServiceProfileInfo¹⁵⁺

服务配置信息。根据云端返回的数据填充。

系统能力：SystemCapability.DistributedHardware.DeviceManager

系统API： 此接口为系统接口。

DeviceProfileInfo¹⁵⁺

设备信息。

系统能力：SystemCapability.DistributedHardware.DeviceManager

系统API： 此接口为系统接口。

DeviceIconInfoFilterOptions¹⁸⁺

设备图标信息过滤选项。

系统能力：SystemCapability.DistributedHardware.DeviceManager

系统API： 此接口为系统接口。

DeviceIconInfo¹⁸⁺

设备图标信息。

系统能力：SystemCapability.DistributedHardware.DeviceManager

系统API： 此接口为系统接口。

NetworkIdQueryFilter¹⁸⁺

设备网络ID过滤器选项。

系统能力：SystemCapability.DistributedHardware.DeviceManager

系统API： 此接口为系统接口。

DeviceManager

设备管理实例，用于获取可信设备和本地设备的相关信息。在调用DeviceManager的方法前，需要先通过createDeviceManager构建一个DeviceManager实例dmInstance。

replyUiAction

replyUiAction(action: number, actionResult: string): void

回复用户UI操作行为。此接口只能被devicemanager的PIN码hap使用。

需要权限：ohos.permission.ACCESS_SERVICE_DM

系统能力：SystemCapability.DistributedHardware.DeviceManager

系统API： 此接口为系统接口。

参数：

错误码：

以下的错误码的详细介绍请参见通用错误码。

示例：

  import { distributedDeviceManager } from '@kit.DistributedServiceKit';
  import { BusinessError } from '@kit.BasicServicesKit';

 try {
    /*
      action = 0 - 允许授权
      action = 1 - 取消授权
      action = 2 - 授权框用户操作超时
      action = 3 - 取消pin码框展示
      action = 4 - 取消pin码输入框展示
      action = 5 - pin码输入框确定操作
    */
    let operation = 0;
    let dmInstance = distributedDeviceManager.createDeviceManager('ohos.samples.jsHelloWorld');
    dmInstance.replyUiAction(operation, 'extra');
  } catch (err) {
    let e: BusinessError = err as BusinessError;
    console.error('replyUiAction errCode:' + e.code + ',errMessage:' + e.message);
  }

on(‘replyResult’)

on(type: ‘replyResult’, callback: Callback<{ param: string;}>): void

回复UI操作结果回调。

需要权限：ohos.permission.ACCESS_SERVICE_DM

系统能力：SystemCapability.DistributedHardware.DeviceManager

系统API： 此接口为系统接口。

参数：

错误码：

以下的错误码的详细介绍请参见通用错误码。

示例：

  import { distributedDeviceManager } from '@kit.DistributedServiceKit';
  import { BusinessError } from '@kit.BasicServicesKit';

  class Data {
    param: string = '';
  }

  interface TmpStr {
    verifyFailed: boolean;
  }

  try {
    let dmInstance = distributedDeviceManager.createDeviceManager('ohos.samples.jsHelloWorld');
    dmInstance.on('replyResult', (data: Data) => {
      console.info('replyResult executed, dialog closed' + JSON.stringify(data));
      let tmpStr: TmpStr = JSON.parse(data.param);
      let isShow = tmpStr.verifyFailed;
      console.info('replyResult executed, dialog closed' + isShow);
    });
  } catch (err) {
    let e: BusinessError = err as BusinessError;
    console.error('replyResult errCode:' + e.code + ',errMessage:' + e.message);
  }

off(‘replyResult’)

off(type: ‘replyResult’, callback?: Callback<{ param: string;}>): void

取消回复UI操作结果回调。

需要权限：ohos.permission.ACCESS_SERVICE_DM

系统能力：SystemCapability.DistributedHardware.DeviceManager

系统API： 此接口为系统接口。

参数：

错误码：

以下的错误码的详细介绍请参见通用错误码。

示例：

  import { distributedDeviceManager } from '@kit.DistributedServiceKit';
  import { BusinessError } from '@kit.BasicServicesKit';

  try {
    let dmInstance = distributedDeviceManager.createDeviceManager('ohos.samples.jsHelloWorld');
    dmInstance.off('replyResult');
  } catch (err) {
    let e: BusinessError = err as BusinessError;
    console.error('replyResult errCode:' + e.code + ',errMessage:' + e.message);
  }

setHeartbeatPolicy¹⁵⁺

setHeartbeatPolicy(policy: StrategyForHeartbeat, delayTime: number): void

设置心跳广播策略。

需要权限：ohos.permission.ACCESS_SERVICE_DM

系统能力：SystemCapability.DistributedHardware.DeviceManager

系统API： 此接口为系统接口。

参数：

错误码：

以下的错误码的详细介绍请参见通用错误码和设备管理错误码。

示例：

  import { distributedDeviceManager } from '@kit.DistributedServiceKit';
  import { BusinessError } from '@kit.BasicServicesKit';

  try {
    let policy = distributedDeviceManager.StrategyForHeartbeat.TEMP_STOP_HEARTBEAT;
    let delayTime = 1000;
    let dmInstance = distributedDeviceManager.createDeviceManager('ohos.samples.jsHelloWorld');
    dmInstance.setHeartbeatPolicy(policy, delayTime);
  } catch (err) {
    let e: BusinessError = err as BusinessError;
    console.error('setHeartbeatPolicy errCode:' + e.code + ',errMessage:' + e.message);
  }

getDeviceProfileInfoList¹⁵⁺

getDeviceProfileInfoList(filterOptions: DeviceProfileInfoFilterOptions): Promise<Array<DeviceProfileInfo>>

获取同账号下全部的设备列表，使用Promise异步回调。

需要权限：ohos.permission.ACCESS_SERVICE_DM

系统能力：SystemCapability.DistributedHardware.DeviceManager

系统API： 此接口为系统接口。

参数：

返回值：

错误码：

以下的错误码的详细介绍请参见通用错误码和设备管理错误码。

示例：

  import { distributedDeviceManager } from '@kit.DistributedServiceKit';
  import { BusinessError } from '@kit.BasicServicesKit';

  try {
    let dmInstance = distributedDeviceManager.createDeviceManager('ohos.samples.jsHelloWorld');
    dmInstance.getDeviceProfileInfoList({"isCloud": false}).then((data: Array<distributedDeviceManager.DeviceProfileInfo>) => {
      console.info('getDeviceProfileInfoList' + JSON.stringify(data));
    }).catch((e: BusinessError) => {
      console.error('getDeviceProfileInfoList errCode:' + e.code + ',errMessage:' + e.message);
    });
  } catch (err) {
    let e: BusinessError = err as BusinessError;
    console.error('getDeviceProfileInfoList errCode:' + e.code + ',errMessage:' + e.message);
  }

putDeviceProfileInfoList¹⁸⁺

putDeviceProfileInfoList(deviceProfileInfoList: Array<DeviceProfileInfo>): Promise<number>

业务调用更新设备列表，使用Promise异步回调。

需要权限：ohos.permission.ACCESS_SERVICE_DM

系统能力：SystemCapability.DistributedHardware.DeviceManager

系统API： 此接口为系统接口。

参数：

返回值：

错误码：

以下的错误码的详细介绍请参见通用错误码和设备管理错误码。

示例：

  import { distributedDeviceManager } from '@kit.DistributedServiceKit';
  import { BusinessError } from '@kit.BasicServicesKit';

  try {
    let dmInstance = distributedDeviceManager.createDeviceManager('ohos.samples.jsHelloWorld');
    let deviceProfileInfoList:Array<distributedDeviceManager.DeviceProfileInfo> = [];
    dmInstance.putDeviceProfileInfoList(deviceProfileInfoList).then((data:number) => {
      console.info('put device profile info:' + JSON.stringify(data));
    }).catch((e: BusinessError) => {
      console.error('putDeviceProfileInfoList errCode:' + e.code + ',errMessage:' + e.message);
    });
  } catch (err) {
    let e: BusinessError = err as BusinessError;
    console.error('putDeviceProfileInfoList errCode:' + e.code + ',errMessage:' + e.message);
  }

getDeviceIconInfo¹⁸⁺

getDeviceIconInfo(filterOptions: DeviceIconInfoFilterOptions): Promise<DeviceIconInfo>

获取设备图标，使用Promise异步回调。

需要权限：ohos.permission.ACCESS_SERVICE_DM

系统能力：SystemCapability.DistributedHardware.DeviceManager

系统API： 此接口为系统接口。

参数：

返回值：

错误码：

以下的错误码的详细介绍请参见通用错误码和设备管理错误码。

示例：

  import { distributedDeviceManager } from '@kit.DistributedServiceKit';
  import { BusinessError } from '@kit.BasicServicesKit';
  
  try {
    let dmInstance = distributedDeviceManager.createDeviceManager('ohos.samples.jsHelloWorld');
    let productIds:Array<string> = ['M0D2', 'M0D3', 'M0D5', 'M0AB', 'M0BD', 'M0E9', 'M0BC', 'M0EA'];
    let options:distributedDeviceManager.DeviceIconInfoFilterOptions = {
      productId: 'P14U',
      imageType: 'ID',
      specName: 'lg',
    };
    if (productIds.indexOf(options.productId) != -1) {
      options.internalModel = '';
    } else {
      options.subProductId = '';
    }
    dmInstance.getDeviceIconInfo(options).then((data: distributedDeviceManager.DeviceIconInfo) => {
      console.info('getDeviceIconInfo' + JSON.stringify(data));
    }).catch((e : BusinessError) => {
      console.error('getDeviceIconInfo errCode:' + e.code + ',errMessage:' + e.message);
    });
  } catch (err) {
    let e: BusinessError = err as BusinessError;
    console.error('getDeviceIconInfo errCode:' + e.code + ',errMessage:' + e.message);
  }

getLocalDisplayDeviceName¹⁸⁺

getLocalDisplayDeviceName(maxNameLength: number): Promise<string>

获取本机指定长度（字节数）的显示名，使用Promise异步回调。

需要权限：ohos.permission.ACCESS_SERVICE_DM

系统能力：SystemCapability.DistributedHardware.DeviceManager

系统API： 此接口为系统接口。

参数：

返回值：

错误码：

以下的错误码的详细介绍请参见通用错误码和设备管理错误码。

示例：

  import { distributedDeviceManager } from '@kit.DistributedServiceKit';
  import { BusinessError } from '@kit.BasicServicesKit';

  try {
    let dmInstance = distributedDeviceManager.createDeviceManager('ohos.samples.jsHelloWorld');
    let maxNameLength:number = 21;
    dmInstance.getLocalDisplayDeviceName(maxNameLength).then((data:string)=>{
      console.info('getLocalDisplayDeviceName name:' + JSON.stringify(data));
    }).catch((e: BusinessError)=>{
      console.error('getLocalDisplayDeviceName errCode:' + e.code + ',errMessage:' + e.message);
    });
  } catch (err) {
    let e: BusinessError = err as BusinessError;
    console.error('getLocalDisplayDeviceName errCode:' + e.code + ',errMessage:' + e.message);
  }

setLocalDeviceName¹⁸⁺

setLocalDeviceName(deviceName: string): Promise<number>

修改本机设备名称，使用Promise异步回调。

需要权限：ohos.permission.ACCESS_SERVICE_DM

系统能力：SystemCapability.DistributedHardware.DeviceManager

系统API： 此接口为系统接口。

参数：

返回值：

错误码：

以下的错误码的详细介绍请参见通用错误码和设备管理错误码。

示例：

  import { distributedDeviceManager } from '@kit.DistributedServiceKit';
  import { BusinessError } from '@kit.BasicServicesKit';

  try {
    let dmInstance = distributedDeviceManager.createDeviceManager('ohos.samples.jsHelloWorld');
    let deviceName:string = 'xxx';
    dmInstance.setLocalDeviceName(deviceName).then((data:number)=>{
      console.info('setLocalDeviceName name:' + JSON.stringify(data));
    }).catch((e: BusinessError)=>{
      console.error('setLocalDeviceName errCode:' + e.code + ',errMessage:' + e.message);
    });
  } catch (err) {
    let e: BusinessError = err as BusinessError;
    console.error('setLocalDeviceName errCode:' + e.code + ',errMessage:' + e.message);
  }

setRemoteDeviceName¹⁸⁺

setRemoteDeviceName(deviceId: string, deviceName: string): Promise<number>

设置配件设备名称，使用Promise异步回调。

需要权限：ohos.permission.ACCESS_SERVICE_DM

系统能力：SystemCapability.DistributedHardware.DeviceManager

系统API： 此接口为系统接口。

参数：

返回值：

错误码：

以下的错误码的详细介绍请参见通用错误码和设备管理错误码。

示例：

  import { distributedDeviceManager } from '@kit.DistributedServiceKit';
  import { BusinessError } from '@kit.BasicServicesKit';

  try {
    let dmInstance = distributedDeviceManager.createDeviceManager('ohos.samples.jsHelloWorld');
    let deviceId:string = 'xxx';
    let deviceName:string = 'xxx';
    dmInstance.setRemoteDeviceName(deviceId, deviceName).then((data:number)=>{
      console.info('setRemoteDeviceName name:' + JSON.stringify(data));
    }).catch((e: BusinessError)=>{
      console.error('setRemoteDeviceName errCode:' + e.code + ',errMessage:' + e.message);
    });
  } catch (err) {
    let e: BusinessError = err as BusinessError;
    console.error('setRemoteDeviceName errCode:' + e.code + ',errMessage:' + e.message);
  }

restoreLocalDeivceName¹⁸⁺

restoreLocalDeivceName(): void

系统重置还原网络设置时，还原本机设备名。

需要权限：ohos.permission.ACCESS_SERVICE_DM

系统能力：SystemCapability.DistributedHardware.DeviceManager

系统API： 此接口为系统接口。

错误码：

以下的错误码的详细介绍请参见通用错误码和设备管理错误码。

示例：

  import { distributedDeviceManager } from '@kit.DistributedServiceKit';
  import { BusinessError } from '@kit.BasicServicesKit';

  try {
    let dmInstance = distributedDeviceManager.createDeviceManager('ohos.samples.jsHelloWorld');
    dmInstance.restoreLocalDeivceName();
  } catch (err) {
    let e: BusinessError = err as BusinessError;
    console.error('restoreLocalDeivceName errCode:' + e.code + ',errMessage:' + e.message);
  }

getDeviceNetworkIdList¹⁸⁺

getDeviceNetworkIdList(filterOptions: NetworkIdQueryFilter): Promise<Array<string>>

获取符合条件的网络设备ID列表。

需要权限：ohos.permission.ACCESS_SERVICE_DM

系统能力：SystemCapability.DistributedHardware.DeviceManager

系统API： 此接口为系统接口。

参数：

返回值：

错误码：

以下的错误码的详细介绍请参见通用错误码和设备管理错误码。

示例：

  import { distributedDeviceManager } from '@kit.DistributedServiceKit';
  import { BusinessError } from '@kit.BasicServicesKit';

  try {
    let queryFiler: distributedDeviceManager.NetworkIdQueryFilter = {
      wiseDeviceId: '',
      onlineStatus: 1,
    }
    let dmInstance = distributedDeviceManager.createDeviceManager('ohos.samples.jsHelloWorld');
    dmInstance.getDeviceNetworkIdList(queryFiler).then((data:Array<string>) => {
      console.info('getDeviceNetworkIdList name:' + JSON.stringify(data));
    }).catch((e: BusinessError) => {
      console.error('getDeviceNetworkIdList errCode:' + e.code + ',errMessage:' + e.message);
    })
  } catch (err) {
    let e: BusinessError = err as BusinessError;
    console.error('getDeviceNetworkIdList errCode:' + e.code + ',errMessage:' + e.message);
  }

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Distributed Service Kit（分布式管理服务）

harmony 鸿蒙DeviceManager

harmony 鸿蒙oh_device_manager_err_code.h

harmony 鸿蒙oh_device_manager.h

harmony 鸿蒙设备管理错误码

harmony 鸿蒙键鼠穿越管理错误码

harmony 鸿蒙增强连接错误码

harmony 鸿蒙@ohos.distributedHardware.deviceManager (设备管理)(系统接口)

harmony 鸿蒙@ohos.cooperate (键鼠穿越)（系统接口）

harmony 鸿蒙@ohos.distributedsched.abilityConnectionManager (应用多端协同管理)(系统接口)