BluetoothPairingHandle (Firefox OS)

This API is available on Firefox OS for internal applications only.

The BluetoothPairingHandle interface of the Web Bluetooth API contains the functionality required for completing a device pairing operation, including passkeys, and mechanisms to reply to user-entered pin codes and confirm passkeys.

Interface overview

interface BluetoothPairingHandle
  readonly attribute unsigned DOMString? <a href="" class="external" title="B2G/Bluetooth/WebBluetooth-v2/BluetoothPairingEvent">passkey</a>;

  Promise<void> <a href="" class="external" title="B2G/Bluetooth/WebBluetooth-v2/BluetoothPairingEvent">setPinCode(DOMString aPinCode)</a>;
  Promise<void> <a href="" class="external" title="B2G/Bluetooth/WebBluetooth-v2/BluetoothPairingEvent">accept()</a>;
  Promise<void> <a href="" class="external" title="B2G/Bluetooth/WebBluetooth-v2/BluetoothPairingEvent">reject()</a>;


The passkey generated during the pairing process when both devices support secure simple pairing (SSP.)


Provides the remote device with a PIN code when the local bluetooth adapter is pairing with it.
Accepts the pairing of the local bluetooth adapter with the remote device.
Rejects the pairing of the local bluetooth adapter with the remote device.


Specification Status Comment
Web Bluetooth
The definition of 'BluetoothPairingHandle' in that specification.
Draft Rough draft; not part of any official specification yet. It should be discussed as part of the W3C's System Applications Working Group.

Browser Compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support No support No support No support No support No support
Feature Android Android Webview Firefox Mobile (Gecko) Firefox OS IE Mobile Opera Mobile Safari Mobile Chrome for Android
Basic support No support No support No support 2.1 No support No support No support No support


See also

Using the Web Bluetooth API


© 2016 Mozilla Contributors
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.

API B2G Bluetooth BluetoothPairingHandle Certified Firefox OS Interface Non-standard Reference Web Bluetooth