BluetoothManager (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 BluetoothManager interface of the Web Bluetooth API allows to access all Bluetooth adapters available on the device. Adapters are the connection interface to connect a Bluetooth device to that device.

Interface overview

[CheckPermissions="bluetooth"]
interface BluetoothManager: EventTarget
{
  readonly attribute BluetoothAdapter? defaultAdapter;

           attribute EventHandler onattributechanged;
           attribute EventHandler onadapteradded;
           attribute EventHandler onadapterremoved;

  sequence<BluetoothAdapter> getAdapters();
};

Properties

BluetoothManager.enabled Read only
A boolean indicating whether the Bluetooth is on (true) or off (false).

Event Handlers

BluetoothManager.onadapteradded
A handler for the adapteradded event; it is triggered when a Bluetooth adapter is enabled on the device.
BluetoothManager.onadapterremoved
A handler for the adapterremoved event; it is triggered when a Bluetooth adapter is disabled on the device, or removed.
BluetoothManager.onattributechanged
A handler for the attributechanged event; it is triggered when the BluetoothManager.defaultAdapter property changes.

Note: Because the BluetoothManager interface inherits from the EventTarget interface, all these events can be listened by using the addEventListener method.

Obsolete event handlers

BluetoothManager.onenabled
A handler for the enabled event; it is triggered when the Bluetooth is turned on.
BluetoothManager.ondisabled
A handler for the disabled event; it is triggered when the Bluetooth is turned off.

Methods

BluetoothManager.getAdapters()
Returns a list of the current BluetoothAdapters in use on the device.

Obsolete methods

BluetoothManager.getDefaultAdapter()
Allows to retrieve the default adapter in use by the device. Returns a DOMRequest to handle the success or error of the operation. In case of success, the request's result is a BluetoothAdapter object. Superceded by the BluetoothManager.getAdapters() method.

Specifications

Specification Status Comment
Web Bluetooth
The definition of 'BluetoothManager' 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
Bluetooth 'v2' support: getAdapters(), onattributechange, onadapterremoved Not supported Not supported Not supported 2.1 Not supported Not supported Not supported Not supported
Bluetooth initial support: getDefaultAdapter(), onenabled, ondisabled, onadapteradded Not supported Not supported Not supported 1.0.1 Not supported Not supported Not supported Not supported

 

See also

 

Using the Web Bluetooth API

Document Tags and Contributors

Last updated by: chrisdavidmills,