文档管理中心
您当前正在浏览HarmonyOS最新文档,覆盖已发布的所有API版本,可在API参考中筛选您使用的API版本。详细的版本配套关系请参考版本说明
指南与API参考API参考系统网络Connectivity Kit(短距通信服务)ArkTS API@ohos.bluetooth.pan (蓝牙pan模块)

@ohos.bluetooth.pan (蓝牙pan模块)

Phone12+PC/2in113+Tablet12+TV19+Wearable18+

本模块提供基于蓝牙个人局域网协议(Personal Area Networking,PAN)的蓝牙共享网络能力,支持本端作为NAP设备和PANU设备查询PAN支持状态、网络共享状态及获取连接状态等,适用于需要通过蓝牙实现个人局域网共享网络的场景。

说明

本模块首批接口从API version 10开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

导入模块

收起
自动换行
深色代码主题
复制
  1. import { pan } from '@kit.ConnectivityKit';

BaseProfile

Phone12+PC/2in113+Tablet12+TV19+Wearable18+

type BaseProfile = baseProfile.BaseProfile

基础Profile接口定义,提供订阅和获取连接状态等公共能力。

系统能力:SystemCapability.Communication.Bluetooth.Core

模型约束:此接口仅可在Stage模型下使用。

展开
类型 说明
baseProfile.BaseProfile 基础Profile接口定义。

pan.createPanProfile

Phone12+PC/2in113+Tablet12+TV19+Wearable18+

createPanProfile(): PanProfile

创建蓝牙PAN实例。通过该实例可使用本端作为NAP设备和PANU设备的接口,如:获取和其他设备间的蓝牙个人局域网服务连接状态。

系统能力:SystemCapability.Communication.Bluetooth.Core

模型约束:此接口仅可在Stage模型下使用。

返回值

展开
类型 说明
PanProfile 返回PAN实例。该类继承于BaseProfile,因此可以使用其父类中的方法。

错误码

以下错误码的详细介绍请参见通用错误码说明文档

展开
错误码ID 错误信息
401 Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed.
801 Capability not supported.

示例

收起
自动换行
深色代码主题
复制
  1. try {
  2. let panProfile : pan.PanProfile= pan.createPanProfile();
  3. console.info('pan success');
  4. } catch (err) {
  5. console.error('errCode: ' + (err as BusinessError).code + ', errMessage: ' + (err as BusinessError).message);
  6. }

PanProfile

Phone12+PC/2in113+Tablet12+TV19+Wearable18+

表示蓝牙PAN通信的实例,提供查询本端PAN支持状态、网络共享状态等能力,适用于蓝牙个人局域网共享网络场景。

  • 使用PanProfile方法之前需要创建该类的实例进行操作,通过createPanProfile方法构造此实例。
  • 该类继承于BaseProfile,因此可以使用其父类中的方法。

isPanSupported

Phone26.0.0+PC/2in126.0.0+Tablet26.0.0+TV26.0.0+Wearable26.0.0+

isPanSupported(): boolean

本端作为NAP角色时使用,查询本端设备是否支持PAN能力。

起始版本:26.0.0

系统能力:SystemCapability.Communication.Bluetooth.Core

模型约束:此接口仅可在Stage模型下使用。

返回值

展开
类型 说明
boolean 当前设备支持PAN时返回true,不支持时返回false。

错误码

以下错误码的详细介绍请参见蓝牙服务子系统错误码

展开
错误码ID 错误信息
2900099 Operation failed.

示例

收起
自动换行
深色代码主题
复制
  1. try {
  2. let panProfile: pan.PanProfile = pan.createPanProfile();
  3. let isPanSupported: boolean = panProfile.isPanSupported();
  4. } catch (err) {
  5. console.error(`errCode: ${err.code}, errMessage: ${err.message}`);
  6. }

isTetheringOn

Phone26.0.0+PC/2in126.0.0+Tablet26.0.0+

isTetheringOn(): boolean

本端作为NAP时使用,获取本端网络共享状态。

起始版本:26.0.0

需要权限:ohos.permission.ACCESS_BLUETOOTH

系统能力:SystemCapability.Communication.Bluetooth.Core

模型约束:此接口仅可在Stage模型下使用。

返回值

展开
类型 说明
boolean 网络共享开启返回true,网络共享关闭返回false。

错误码

以下错误码的详细介绍请参见通用错误码说明文档

展开
错误码ID 错误信息
201 Permission denied.
801 Capability not supported. Only can be called on phone, tablet, and 2in1 devices. Failed to call the API when the short-range chip is not inserted on 2in1 device.

示例

收起
自动换行
深色代码主题
复制
  1. try {
  2. let panProfile: pan.PanProfile = pan.createPanProfile();
  3. let isTetheringOn: boolean = panProfile.isTetheringOn();
  4. } catch (err) {
  5. console.error(`errCode: ${err.code}, errMessage: ${err.message}`);
  6. }