BluetoothDeviceEvent (Firefox OS)

Non-standard
This feature is not on a current W3C standards track, but it is supported on the Firefox OS platform. Although implementations may change in the future and it is not supported widely across browsers, it is suitable for use in code dedicated to Firefox OS apps.

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

The BluetoothDeviceEvent interface of the Web Bluetooth API provides access to a found/paired device (BluetoothDevice) object or the address or an unpaired device as the parameter of a devicefounddevicepaired or deviceunpaired event handler (see BluetoothDiscoveryHandle.ondevicefound, BluetoothAdapter.ondevicepaired, and BluetoothAdapter.ondeviceunpaired), when fired.

Interface overview

[CheckPermissions="bluetooth"]
interface BluetoothDeviceEvent : Event
{
  readonly attribute BluetoothDevice? device;
  readonly attribute DOMString? address;
};

Properties

BluetoothDeviceEvent.device Read only
Returns a BluetoothDevice object representing the paired remote device. Returns null for the BluetoothAdapter.ondeviceunpaired event handler since the that only requires the address of the unpaired device.
BluetoothDeviceEvent.address Read only
Returns a DOMString representing the address of the unpaired remote device. Returns null for the BluetoothDiscoveryHandle.ondevicefound and BluetoothAdapter.ondevicepaired event handlers since a found/paired remote device already has an BluetoothDevice.address property.

Methods

None.

Specifications

Specification Status Comment
Web Bluetooth
The definition of 'BluetoothDeviceEvent' 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 Not supported Not supported Not supported Not supported Not supported
Feature Android Android Webview Firefox Mobile (Gecko) Firefox OS IE Mobile Opera Mobile Safari Mobile Chrome for Android
Basic support Not supported Not supported Not supported 2.1 Not supported Not supported Not supported Not supported

 

See also

Using the Web Bluetooth API

Document Tags and Contributors

Contributors to this page: chrisdavidmills, fscholz, teoli, Jamin_Liu, kscarfone, Jeremie
Last updated by: chrisdavidmills,