• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.bluetooth (Bluetooth) (System API)
2
3The **Bluetooth** module provides classic Bluetooth capabilities and Bluetooth Low Energy (BLE) scan and advertising.
4
5> **NOTE**
6> The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version.
7> The APIs provided by this module are no longer maintained since API version 9. You are advised to use profile APIs of [@ohos.bluetooth.ble](js-apis-bluetooth-ble.md).
8> This topic describes only the system APIs provided by the module. For details about its public APIs, see [@ohos.bluetooth (Bluetooth)](js-apis-bluetooth.md).
9
10## Modules to Import
11
12```js
13import bluetooth from '@ohos.bluetooth';
14```
15
16## bluetooth.cancelPairedDevice<sup>8+</sup><sup>(deprecated)</sup><a name="cancelPairedDevice"></a>
17
18cancelPairedDevice(deviceId: string): boolean
19
20Cancels a paired remote device.
21
22> **NOTE**<br>
23> This API is supported since API version 8 and deprecated since API version 9. Use [bluetoothManager.cancelPairedDevice](js-apis-bluetoothManager-sys.md#bluetoothmanagercancelpaireddevicedeprecated) instead.
24
25**System API**: This is a system API.
26
27**Required permissions**: ohos.permission.DISCOVER_BLUETOOTH
28
29**System capability**: SystemCapability.Communication.Bluetooth.Core
30
31**Parameters**
32
33| Name     | Type    | Mandatory  | Description                                   |
34| -------- | ------ | ---- | ------------------------------------- |
35| deviceId | string | Yes   | Address of the remote device to cancel, for example, XX:XX:XX:XX:XX:XX.|
36
37**Return value**
38
39| Type     | Description                        |
40| ------- | -------------------------- |
41| boolean | Returns **true** if the operation is successful; returns **false** otherwise.|
42
43**Example**
44
45```js
46let result : boolean = bluetooth.cancelPairedDevice("XX:XX:XX:XX:XX:XX");
47```
48