js-apis-bluetooth-pan.md 3.9 KB
Newer Older
L
lverpeng 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
# @ohos.bluetooth.pan (蓝牙socket模块)

pan模块提供了访问蓝牙个人区域网相关功能的方法。

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



## 导入模块

```js
import pan from '@ohos.bluetooth.pan';
```


## pan.createPanProfile<a name="createPanProfile"></a>

createPanProfile(): PanProfile

创建pan profile实例。

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

**返回值:**

| 类型                            | 说明         |
| ----------------------------- | ---------- |
| PanProfile | 返回该profile的实例。 |

**示例:**

```js
try {
    let panProfile = pan.createPanProfile();
    console.info('pan success');
} catch (err) {
    console.error('errCode: ' + err.code + ', errMessage: ' + err.message);
}
```


## PanProfile

使用PanProfile方法之前需要创建该类的实例进行操作,通过createPanProfile()方法构造此实例。


### disconnect<a name="PanP-disconnect"></a>

disconnect(deviceId: string): void

断开连接设备的Pan服务。

**系统接口**:此接口为系统接口。

**需要权限**:ohos.permission.ACCESS_BLUETOOTH

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

**参数:**

| 参数名    | 类型     | 必填   | 说明      |
| ------ | ------ | ---- | ------- |
| deviceId | string | 是    | 远端设备地址。 |

**错误码**

以下错误码的详细介绍请参见[蓝牙服务子系统错误码](../errorcodes/errorcode-bluetoothManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------- |
|2900001 | Service stopped.                         |
|2900003 | Bluetooth switch is off.                 |
|2900004 | Profile is not supported.                |
|2900099 | Operation failed.                        |

**示例:**

```js
try {
    let panProfile = pan.createPanProfile();
    panProfile.disconnect('XX:XX:XX:XX:XX:XX');
} catch (err) {
    console.error('errCode: ' + err.code + ', errMessage: ' + err.message);
}
```


### setTethering<a name="setTethering"></a>

setTethering(enable: boolean): void

设置网络共享状态。

**系统接口**:此接口为系统接口。

**需要权限**:ohos.permission.ACCESS_BLUETOOTH 和 ohos.permission.MANAGE_BLUETOOTH

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

**参数:**

| 参数名    | 类型     | 必填   | 说明      |
| ------ | ------ | ---- | ------- |
| value | boolean | 是    | 是否设置蓝牙共享。 |

**错误码**

以下错误码的详细介绍请参见[蓝牙服务子系统错误码](../errorcodes/errorcode-bluetoothManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------- |
|2900001 | Service stopped.                         |
|2900003 | Bluetooth switch is off.                 |
|2900004 | Profile is not supported.                |
|2900099 | Operation failed.                        |

**示例:**

```js
try {
    let panProfile = pan.createPanProfile();
    panProfile.setTethering(false);
} catch (err) {
    console.error('errCode: ' + err.code + ', errMessage: ' + err.message);
}
```


### isTetheringOn<a name="isTetheringOn"></a>

isTetheringOn(): boolean

获取网络共享状态。

**系统接口**:此接口为系统接口。

**需要权限**:ohos.permission.ACCESS_BLUETOOTH

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

**返回值:**

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

**示例:**

```js
try {
    let panProfile = pan.createPanProfile();
    let ret = panProfile.isTetheringOn();
} catch (err) {
    console.error('errCode: ' + err.code + ', errMessage: ' + err.message);
}
```