@ohos.bluetooth.pan (蓝牙pan模块)
pan模块提供了访问蓝牙个人区域网相关功能的方法。
说明:
本模块首批接口从API version 10开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
导入模块
import pan from '@ohos.bluetooth.pan';
pan.createPanProfile
createPanProfile(): PanProfile
创建pan profile实例。
系统能力:SystemCapability.Communication.Bluetooth.Core。
返回值:
类型 | 说明 |
---|---|
PanProfile | 返回该profile的实例。 |
示例:
import { BusinessError } from '@ohos.base';
try {
let panProfile : pan.PanProfile= pan.createPanProfile();
console.info('pan success');
} catch (err) {
console.error('errCode: ' + (err as BusinessError).code + ', errMessage: ' + (err as BusinessError).message);
}
PanProfile
使用PanProfile方法之前需要创建该类的实例进行操作,通过createPanProfile()方法构造此实例。
disconnect
disconnect(deviceId: string): void
断开连接设备的Pan服务。
系统接口:此接口为系统接口。
需要权限:ohos.permission.ACCESS_BLUETOOTH
系统能力:SystemCapability.Communication.Bluetooth.Core。
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
deviceId | string | 是 | 远端设备地址。 |
错误码:
以下错误码的详细介绍请参见蓝牙服务子系统错误码。
错误码ID | 错误信息 |
---|---|
2900001 | Service stopped. |
2900003 | Bluetooth switch is off. |
2900004 | Profile is not supported. |
2900099 | Operation failed. |
示例:
import { BusinessError } from '@ohos.base';
try {
let panProfile: pan.PanProfile = pan.createPanProfile();
panProfile.disconnect('XX:XX:XX:XX:XX:XX');
} catch (err) {
console.error('errCode: ' + (err as BusinessError).code + ', errMessage: ' + (err as BusinessError).message);
}
setTethering
setTethering(enable: boolean): void
设置网络共享状态。
系统接口:此接口为系统接口。
需要权限:ohos.permission.ACCESS_BLUETOOTH 和 ohos.permission.MANAGE_BLUETOOTH
系统能力:SystemCapability.Communication.Bluetooth.Core。
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
value | boolean | 是 | 是否设置蓝牙共享。 |
错误码:
以下错误码的详细介绍请参见蓝牙服务子系统错误码。
错误码ID | 错误信息 |
---|---|
2900001 | Service stopped. |
2900003 | Bluetooth switch is off. |
2900004 | Profile is not supported. |
2900099 | Operation failed. |
示例:
import { BusinessError } from '@ohos.base';
try {
let panProfile: pan.PanProfile = pan.createPanProfile();
panProfile.setTethering(false);
} catch (err) {
console.error('errCode: ' + (err as BusinessError).code + ', errMessage: ' + (err as BusinessError).message);
}
isTetheringOn
isTetheringOn(): boolean
获取网络共享状态。
系统接口:此接口为系统接口。
需要权限:ohos.permission.ACCESS_BLUETOOTH
系统能力:SystemCapability.Communication.Bluetooth.Core。
返回值:
类型 | 说明 |
---|---|
boolean | 网络共享开启返回true,网络共享关闭返回false。 |
示例:
import { BusinessError } from '@ohos.base';
try {
let panProfile: pan.PanProfile = pan.createPanProfile();
panProfile.isTetheringOn();
} catch (err) {
console.error('errCode: ' + (err as BusinessError).code + ', errMessage: ' + (err as BusinessError).message);
}