B2G OS

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

[CheckPermissions="bluetooth"]
interface BluetoothPairingHandle
{
  readonly attribute unsigned DOMString? passkey;

  Promise<void> setPinCode(DOMString aPinCode);
  Promise<void> accept();
  Promise<void> reject();
};

Properties

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

Methods

BluetoothPairingHandle.setPinCode()
Provides the remote device with a PIN code when the local bluetooth adapter is pairing with it.
BluetoothPairingHandle.accept()
Accepts the pairing of the local bluetooth adapter with the remote device.
BluetoothPairingHandle.reject()
Rejects the pairing of the local bluetooth adapter with the remote device.

Specifications

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

Supported in Firefox OS 2.1

See also

Using the Web Bluetooth API

Document Tags and Contributors

Contributors to this page: fscholz, chrisdavidmills
Last updated by: fscholz,