B2G/Bluetooth/WebBluetooth-v2/BluetoothManager: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
Line 66: Line 66:


; Description
; Description
: The <tt>getAdapters</tt> method retrieves all adapters on the device.
: The method retrieves all adapters on the device.


; Return
; Return
Line 78: Line 78:


; Description
; Description
: The <tt>getDefaultAdapter</tt> method retrieves the default adapter used to connect to the remote bluetooth devices.
: The method retrieves the default adapter used to connect to the remote bluetooth devices.


; Return
; Return

Revision as of 06:52, 21 March 2014

Overview

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

Interface

interface BluetoothManager: EventTarget
{
  attribute EventHandler onadapteradded;
  attribute EventHandler onadapterremoved;

  any              getAdapters(); // array of BluetoothAdapter
  BluetoothAdapter getDefaultAdapter();
};

Event Handlers

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 and property isDefault indicating whether the added adapter is default adapter.
Sample
function bt_onAdapterAdded(evt) {
  var adapter = evt.adapter;
  var isDefaultAdapter = evt.isDefault;

  if (isDefaultAdapter) {
    // do your things here.
  }
}

var manager = navigator.mozBluetooth;
manager.onadapteradded = bt_onAdapterAdded;

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 and property isDefault indicating whether the removed adapter is default adapter.
Sample
function bt_onAdapterRemoved(evt) {
  var address = evt.address;
  var isDefaultAdapter = evt.isDefault;

  if (isDefaultAdapter) {
    // do your things here.
  }
}

var manager = navigator.mozBluetooth;
manager.onadapterremoved = bt_onAdapterRemoved;

Methods

getAdapters()

Description
The method retrieves all adapters on the device.
Return
An array of BluetoothAdapter objects.
Sample
var manager = navigator.mozBluetooth;
var adapters = manager.getAdapters();

getDefaultAdapter()

Description
The method retrieves the default adapter used to connect to the remote bluetooth devices.
Return
The default BluetoothAdapter object.
Sample
var manager = navigator.mozBluetooth;
var adapter = manager.getDefaultAdapter();

See also