B2G OS

BluetoothPairingEvent (Firefox OS)

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

The BluetoothPairingEvent interface of the Web Bluetooth API provides access to a device's name and the BluetoothPairingHandle object required for pairing devices as the parameter of pairing-related handlers (for example including BluetoothPairingListener.ondisplaypasskeyreq and BluetoothPairingListener.onenterpincodereq), when fired.

Interface overview

[CheckPermissions="bluetooth"]
interface BluetoothPairingEvent : Event
{
  readonly attribute DOMString              deviceName;
  readonly attribute BluetoothPairingHandle handle;
};

Properties

BluetoothPairingEvent.deviceName Read only
Returns a DOMString representing the name of the remote pairing bluetooth device.
BluetoothPairingEvent.handle Read only
Returns a BluetoothPairingHandle object containing the necessary properties and methods for handling the respective pairing type.

Methods

None.

Specifications

Specification Status Comment
Web Bluetooth
The definition of 'BluetoothPairingEvent' 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,