• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.bluetooth.baseProfile (蓝牙baseProfile模块)（系统接口）
2
3baseProfile模块提供了基础的profile方法。
4
5> **说明：**
6>
7> 本模块首批接口从API version 10开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
8> 当前页面仅包含本模块的系统接口，其他公开接口参见[@ohos.bluetooth.baseProfile (蓝牙baseProfile模块)](js-apis-bluetooth-baseProfile.md)
9
10
11## 导入模块
12
13```js
14import baseProfile from '@ohos.bluetooth.baseProfile';
15```
16
17
18## ConnectionStrategy
19
20枚举，表示Profile的连接策略。
21
22**系统接口：** 此接口为系统接口。
23
24**系统能力**：SystemCapability.Communication.Bluetooth.Core。
25
26| 名称                             | 值      | 说明            |
27| -------------------------------- | ------ | --------------- |
28| CONNECTION_STRATEGY_UNSUPPORTED   | 0 | 当设备未配对时的默认连接策略。<br/>此接口为系统接口。 |
29| CONNECTION_STRATEGY_ALLOWED  | 1 |  设备允许接受或发起配对时的连接策略。<br/>此接口为系统接口。 |
30| CONNECTION_STRATEGY_FORBIDDEN  | 2 | 设备不允许接受或发起配对时的连接策略。<br/>此接口为系统接口。  |
31
32
33
34## baseProfile.setConnectionStrategy
35
36setConnectionStrategy(deviceId: string, strategy: ConnectionStrategy, callback: AsyncCallback&lt;void&gt;): void
37
38设置该设备Profile的连接策略。
39
40**系统接口**：此接口为系统接口。
41
42**需要权限**：ohos.permission.ACCESS_BLUETOOTH 和 ohos.permission.MANAGE_BLUETOOTH
43
44**系统能力**：SystemCapability.Communication.Bluetooth.Core。
45
46**参数：**
47
48| 参数名      | 类型     | 必填   | 说明                                  |
49| -------- | ------ | ---- | ----------------------------------- |
50| deviceId | string | 是    | 表示配对的远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
51| strategy | [ConnectionStrategy](#connectionstrategy)   | 是    |Profile的连接策略。 |
52| callback | AsyncCallback&lt;void&gt;  | 是    | 回调函数。当设置成功，err为undefined，否则为错误对象。 |
53
54**错误码**：
55
56以下错误码的详细介绍请参见[蓝牙服务子系统错误码](errorcode-bluetoothManager.md)。
57
58| 错误码ID | 错误信息 |
59| -------- | ---------------------------- |
60|2900001 | Service stopped.                         |
61|2900003 | Bluetooth switch is off.                 |
62|2900004 | Profile is not supported.                |
63|2900099 | Operation failed.                        |
64
65**示例：**
66
67```js
68import { BusinessError } from '@ohos.base';
69import a2dp from '@ohos.bluetooth.a2dp';
70try {
71    let a2dpSrc = a2dp.createA2dpSrcProfile();
72    a2dpSrc.setConnectionStrategy('XX:XX:XX:XX:XX:XX', 0, (err: BusinessError) => {
73        console.info('setConnectionStrategy, err: ' + JSON.stringify(err));
74    });
75} catch (err) {
76    console.error('errCode: ' + (err as BusinessError).code + ', errMessage: ' + (err as BusinessError).message);
77}
78```
79
80## baseProfile.setConnectionStrategy
81
82setConnectionStrategy(deviceId: string, strategy: ConnectionStrategy): Promise&lt;void&gt;
83
84设置该设备Profile的连接策略。
85
86**系统接口**：此接口为系统接口。
87
88**需要权限**：ohos.permission.ACCESS_BLUETOOTH 和 ohos.permission.MANAGE_BLUETOOTH
89
90**系统能力**：SystemCapability.Communication.Bluetooth.Core。
91
92**参数：**
93
94| 参数名      | 类型     | 必填   | 说明                                  |
95| -------- | ------ | ---- | ----------------------------------- |
96| deviceId | string | 是    | 表示配对的远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
97| strategy | [ConnectionStrategy](#connectionstrategy)   | 是    |Profile的连接策略。 |
98
99**返回值：**
100
101| 类型                  | 说明            |
102| ------------------- | ------------- |
103| Promise&lt;void&gt; | 返回promise对象。 |
104
105**错误码**：
106
107以下错误码的详细介绍请参见[蓝牙服务子系统错误码](errorcode-bluetoothManager.md)。
108
109| 错误码ID | 错误信息 |
110| -------- | ---------------------------- |
111|2900001 | Service stopped.                         |
112|2900003 | Bluetooth switch is off.                 |
113|2900004 | Profile is not supported.                |
114|2900099 | Operation failed.                        |
115
116**示例：**
117
118```js
119import { BusinessError } from '@ohos.base';
120import a2dp from '@ohos.bluetooth.a2dp';
121try {
122    let a2dpSrc = a2dp.createA2dpSrcProfile();
123    a2dpSrc.setConnectionStrategy('XX:XX:XX:XX:XX:XX', 1).then(() => {
124        console.info('setConnectionStrategy');
125    }, (err: BusinessError) => {
126        console.error('setConnectionStrategy errCode: ' + err.code + ', errMessage: ' + err.message);
127    });
128} catch (err) {
129    console.error('errCode: ' + (err as BusinessError).code + ', errMessage: ' + (err as BusinessError).message);
130}
131```
132
133## baseProfile.getConnectionStrategy
134
135getConnectionStrategy(deviceId: string, callback: AsyncCallback&lt;ConnectionStrategy&gt;): void
136
137获取该Profile的连接策略。
138
139**系统接口**：此接口为系统接口。
140
141**需要权限**：ohos.permission.ACCESS_BLUETOOTH 和 ohos.permission.MANAGE_BLUETOOTH
142
143**系统能力**：SystemCapability.Communication.Bluetooth.Core。
144
145**参数：**
146
147| 参数名      | 类型     | 必填   | 说明                                  |
148| -------- | ------ | ---- | ----------------------------------- |
149| deviceId | string | 是    | 表示配对的远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
150| callback | AsyncCallback&lt;[ConnectionStrategy](#connectionstrategy)&gt; | 是    | 回调函数。当获取策略成功，err为undefined，否则为错误对象。 |
151
152**错误码**：
153
154以下错误码的详细介绍请参见[蓝牙服务子系统错误码](errorcode-bluetoothManager.md)。
155
156| 错误码ID | 错误信息 |
157| -------- | ---------------------------- |
158|2900001 | Service stopped.                         |
159|2900003 | Bluetooth switch is off.                 |
160|2900004 | Profile is not supported.                |
161|2900099 | Operation failed.                        |
162
163**示例：**
164
165```js
166import { BusinessError } from '@ohos.base';
167import a2dp from '@ohos.bluetooth.a2dp';
168try {
169    let a2dpSrc = a2dp.createA2dpSrcProfile();
170    a2dpSrc.getConnectionStrategy('XX:XX:XX:XX:XX:XX', 0, (err: BusinessError, data: baseProfile.ConnectionStrategy) => {
171        console.info('getConnectionStrategy, err: ' + JSON.stringify(err) + ', data: ' + JSON.stringify(data));
172    });
173} catch (err) {
174    console.error('errCode: ' + (err as BusinessError).code + ', errMessage: ' + (err as BusinessError).message);
175}
176```
177
178## baseProfile.getConnectionStrategy
179
180getConnectionStrategy(deviceId: string): Promise&lt;ConnectionStrategy&gt;
181
182获取该Profile的连接策略。
183
184**系统接口**：此接口为系统接口。
185
186**需要权限**：ohos.permission.ACCESS_BLUETOOTH 和 ohos.permission.MANAGE_BLUETOOTH
187
188**系统能力**：SystemCapability.Communication.Bluetooth.Core。
189
190**参数：**
191
192| 参数名      | 类型     | 必填   | 说明                                  |
193| -------- | ------ | ---- | ----------------------------------- |
194| deviceId | string | 是    | 表示配对的远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
195
196**返回值：**
197
198| 类型                  | 说明            |
199| ------------------- | ------------- |
200|   Promise&lt;[ConnectionStrategy](js-apis-bluetooth-baseProfile-sys.md#connectionstrategy)&gt; | 返回promise对象。 |
201
202**错误码**：
203
204以下错误码的详细介绍请参见[蓝牙服务子系统错误码](errorcode-bluetoothManager.md)。
205
206| 错误码ID | 错误信息 |
207| -------- | ---------------------------- |
208|2900001 | Service stopped.                         |
209|2900003 | Bluetooth switch is off.                 |
210|2900004 | Profile is not supported.                |
211|2900099 | Operation failed.                        |
212
213**示例：**
214
215```js
216import { BusinessError } from '@ohos.base';
217import a2dp from '@ohos.bluetooth.a2dp';
218try {
219    let a2dpSrc = a2dp.createA2dpSrcProfile();
220    a2dpSrc.getConnectionStrategy('XX:XX:XX:XX:XX:XX', 1).then((data: baseProfile.ConnectionStrategy) => {
221        console.info('getConnectionStrategy');
222    }, (err: BusinessError) => {
223        console.error('getConnectionStrategy errCode: ' + err.code + ', errMessage: ' + err.message);
224    });
225} catch (err) {
226    console.error('errCode: ' + (err as BusinessError).code + ', errMessage: ' + (err as BusinessError).message);
227}
228```