B2G/Bluetooth/WebBluetooth-v2/BluetoothManager

From MozillaWiki
Jump to navigation Jump to search

Overview

BluetoothManager allows to access all bluetooth adapters available on the device. Adapters are the interfaces that connect to the remote device.

Interfaces

BluetoothManager

[Func="Navigator::HasBluetoothSupport"]
interface BluetoothManager: EventTarget
{
  readonly attribute BluetoothAdapter defaultAdapter;

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

  sequence<BluetoothAdapter> getAdapters();
};

BluetoothManagerAttribute

enum BluetoothManagerAttribute
{
  "defaultAdapter"
}

Properties

defaultAdapter

Description
The default adapter used to connect to the remote bluetooth devices.
Value type
BluetoothAdapter
Default value
Null pointer if no adapter exists.
Sample
var defaultAdapter = navigator.mozBluetooth.defaultAdapter;

Event Handlers

onattributechanged

Description
A handler to trigger when bluetooth manager's only property (defaultAdapter) has changed.
Parameter
aAttributeEvent
The event is a BluetoothAttributeEvent with property attr as a BluetoothManagerAttribute.
Sample
manager.onattributechanged = function onManagerAttributeChanged(evt) {
 var attr = evt.attr;
 var value = evt.value;

 switch (attr) {
   case BluetoothManagerAttribute.defaultAdapter:
     console.log("defaultAdapter changed. address:", value.address);
     break;
   default:
     break;
 }

}

onadapteradded

Description
A handler to trigger when a bluetooth adapter is added (i.e., plugged in) to the device.
Parameter
aAdapterEvent
The event is a BluetoothAdapterEvent with property adapter as the added bluetooth adapter. If the added adapter becomes default adapter, onattributechanged would also be triggered to reflect the change of property defaultAdapter.
Sample
manager.onadapteradded = function onAdapterAdded(evt) {
  var adapter = evt.adapter;
  // do your things here.
}

onadapterremoved

Description
A handler to trigger when a bluetooth adapter is removed (i.e., unplugged) from the device.
Parameter
aAddressEvent
The event is a BluetoothAdapterEvent with property address as the address of removed bluetooth adapter. If the removed adapter is default adapter, onattributechanged would also be triggered to reflect the change of property defaultAdapter.
Sample
manager.onadapterremoved = function onAdapterRemoved(evt) {
  var address = evt.address;
  // do your things here.
}

Methods

getAdapters()

Description
The method returns an array representing a snapshot of current adapters list on the device. Each getAdapters() call returns a new array instead of a reference to current adapters list, in order to prevent applications from modifying the shared adapters list.
Return
sequence<BluetoothAdapter>
Sample
var adapters = navigator.mozBluetooth.getAdapters();

for (var i = 0; i < adapters.length; i++) {   
  console.log("adapter", i, "address", adapter[i].address);
}
Retrieved from "https://wiki.mozilla.org/index.php?title=B2G/Bluetooth/WebBluetooth-v2/BluetoothManager&oldid=975114"